Changeset 142 for trunk/SRC/ToBeReviewed/PLOTS/DESSINE/splot.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/splot.pro (modified) (2 diffs)

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

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:splot (super plot)
 ;
-; PURPOSE: meme chose que plot mais compatible avec l''ensemble de
-; l'environnement (common.pro est inclu)
+; file_comments 
+; Same thing that plot but compatible with the whole environnement (common.pro inclued)
 ;
-; CATEGORY:dessine
-;
-; CALLING SEQUENCE: PLOT, [X,] Y
+; @categories graphics
 ; 
 ; INPUTS:cd IDL> ?plot
 ;
-; KEYWORD PARAMETERS:
-;  meme que ceux de plot avec en plus:
+; @keyword NOREINITPLT
+; We active it if we do not want environnement variables !p, !x, !y, !z 
+; to be reinitilalizted by the procedure reinitplt
+; 
+; @keyword _EXTRA
+; used to pass your keywords
 ;
-;      NOREINITPLT: a actier si on ne veut pas que les variables
-;      d''environnemet !p, !x, !y, !z soient reinitialisees par la
-;      procedure reinitplt
+; @uses
+; common.pro
 ;
-; OUTPUTS:
+; @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
-;
-; COMMON BLOCKS:common.pro
-;
-; SIDE EFFECTS:
-;
-; RESTRICTIONS:
-;
-; EXAMPLE:
-;
+; @examples
 ;      IDL> splot, indgen(10),ystyle=1,small=[1,2,1],/portrait
 ;      IDL> splot, -indgen(10),ystyle=1,small=[1,2,2],/noerase
-;      IDL> @ps
+;      IDL> \@ps
 ;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history
+; Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;                      18/10/1999
+;
+; @version
+; $Id$
+;
 ;-
 ;------------------------------------------------------------
@@ -50 +46 @@
 ;
 @common
-; 1) je reinitialise l''environnememt graphique (les variables !x, !y et !p): 
+; 1) I reinitializate the graphic environment (les 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 put the drawing on the screen like on the postcript 
    placedessin, 'autre', _extra = ex
-; 3) je fais mon joli dessin 
+; 3) Drawing
    if n_elements(y) EQ 0 then plot,  x, xstyle = 1, ystyle = 1, _EXTRA = ex $
    ELSE plot,  x, y, xstyle = 1, ystyle = 1, _EXTRA = ex
-; 4) je termine le dessin 
+; 4) End of drawing 
    terminedessin, _extra=ex 
 ;