Changeset 142 for trunk/SRC/ToBeReviewed/PLOTS/DESSINE/sbar_plot.pro

Timestamp:

07/21/06 14:47:49 (18 years ago)

Author:

navarro

Message:

english and nicer header (2a)

File:

• trunk/SRC/ToBeReviewed/PLOTS/DESSINE/sbar_plot.pro (modified) (3 diffs)

trunk/SRC/ToBeReviewed/PLOTS/DESSINE/sbar_plot.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:sbar_plot (super bar_plot)
 ;
-; PURPOSE: meme chose que bar_plot mais compatible avec l''ensemble de
-; l'environnement (common.pro est inclu)
+; @file_comments 
+; Same thing that bar_plot but compatible with the whole environnement (common.pro inclued)
 ;
-; CATEGORY:dessine
+; @categories graphics
 ;
-; CALLING SEQUENCE: sbar_plot,y
-; 
 ; INPUTS: cd IDL>?bar_plot
 ;
-; KEYWORD PARAMETERS:
+; @keyword COLORS 
+; A vector, the same size as VALUES, containing the color index
+; to be used for each bar.  If not specified, the colors are
+; selected based on spacing the color indices as widely as
+; possible within the available colors (specified by D.N_COLORS).
 ;
-;  meme que ceux de bar_plot avec en plus:
-;      COLORS: un entier donnant la couleur de toutes les barres de
-;      couleurs. (contrairement a colors qui est en vecteur donnant le
-;      couleur de chaque barre de couleur.
+; @keyword COLORS 
+; Is an integer giving color of all colorbars. (contrarily to colors 
+; which is a vector giving the color of each colorbar).
 ;
-;      NOREINITPLT: a actier si on ne veut pas que les variables
-;      d''environnemet !p, !x, !y, !z soient reinitialisees par la
-;      procedure reinitplt
+; @keyword NOREINITPLT
+; We active it if we do not want environnement variables !p, !x, !y, !z 
+; to be reinitilalizted by the procedure reinitplt
 ;
-; OUTPUTS:
+; @keyword _EXTRA
+; used to pass your keyword
 ;
-; COMMON BLOCKS:common.pro
+; @uses
+; common.pro
 ;
-; SIDE EFFECTS:
+; @restrictions 
+; If NOREINITPLT is not activated, all environnement 
+; variables !p, !x, !y, !z are reinitializtedby the procedure reinitplt
 ;
-;   Si NOREINITPLT n''est pas ective toutes les variables
-;      d''environnemet !p, !x, !y, !z sont reinitialisees par la
-;      procedure reinitplt
-;
-; RESTRICTIONS:
-;
-; EXAMPLE:
-;
+; @examples
 ;      IDL> sbar_plot, indgen(10),small = [2,2,2],/rempli
 ;      IDL> sbar_plot, indgen(10),small = [2,2,3],/noerase
-;      IDL> @ps
+;      IDL> \@ps
 ;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history
+; Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;                      10/10/1999
+;
+; @version
+; $Id$
+;
 ;-
 ;------------------------------------------------------------
@@ -55 +57 @@
 ;
 @common
-; 1) je reinitialise l''environnememt graphique (les variables !x, !y et !p): 
+; 1) I reinitialize the graphic environment (variables !x, !y et !p): 
    if NOT keyword_set(NOREINITPLT) then reinitplt, _extra = ex 
-; 2) je place le dessin a l'ecran comme sur le postcript 
+; 2) I place the drawing on the screen like on the postscript 
    IF chkstru(ex, 'overplot')EQ 0 THEN placedessin, 'autre', _extra = ex
-; 3) je fais mon joli dessin 
+; 3) Drawing 
    if n_elements(COLORS) NE 0 then BEGIN
       if n_elements(COLORS) EQ n_elements(Values) then col = colors $
@@ -67 +69 @@
    bar_plot, Values, background = !p.background, colors = col $
              , xstyle = 1, ystyle = 1, _extra = ex
-; 4) je termine le dessin 
+; 4) End of drawing 
    terminedessin, _extra=ex