Changeset 142 for trunk/SRC/ToBeReviewed/GRILLE/tracegrille.pro

Timestamp:

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

Author:

navarro

Message:

english and nicer header (2a)

File:

• trunk/SRC/ToBeReviewed/GRILLE/tracegrille.pro (modified) (3 diffs)

trunk/SRC/ToBeReviewed/GRILLE/tracegrille.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:tracegrille
 ;
-; PURPOSE:dessine la grille
+; @file_comments
+; Draw the grid
 ;
-; CATEGORY:
+; @categories
+; 
+; @param GLAMIN {in}{required}
+; The 1d or 2d array in longitude of points of the grid.If GLAM/GLAMIN 
+; is not specified, it trace the grid specified by vargrid, on the 
+; domain defined by domdef.
 ;
-; CALLING SEQUENCE:tracegrille
+; @param GPHIIN {in}{required}
+; The 1d or 2d array in latitude of points of the grid.If GPHI/GPHIIN 
+; is not specified, it trace the grid specified by vargrid, on the 
+; domain defined by domdef.
+;
+; @keyword XSTRIDE 
+; It is an integer to specify that we want to trace only one line of 
+; constant i every xstride points
+;
+; @keyword YSTRIDE 
+; It is an integer to specify that we want to trace only one line of 
+; constant j every xstride points
+;
+; @keyword OCEAN 
+; To trace the grid only on ocean points.
 ; 
-; INPUTS:glam et gphi, les tableaux 1d ou 2d des position en
-; longitude/latitude des points de la grille. Si glam et gphi ne sont
-; pas specifies, trace la grille specifiee par vargrid, sur le domaine
-; definit par le dernier domdef.
+; @keyword EARTH
+; To trace the grid only on land points pour ne tracer la grille que sur les points terre
 ;
-; KEYWORD PARAMETERS:
+; @keyword RMOUT
+; Select to remove all cell having one corner out of the
+; plot boundaries (!x.range, !y.range)
 ;
-;        XSTRIDE un entier pour specifier qu''on ne veut tracer
-;        qu''une ligne de i constant tout les xstride points
-;
-;        YSTRIDE un entier pour specifier qu''on ne veut tracer
-;        qu''une ligne de j constant tout les ystride points
-;
-;        /OCEAN: pour ne tracer la grille que sur les points oceans
+; @keyword _EXTRA
+; Used to pass your keywords.
 ; 
-;        /EARTH: pour ne tracer la grille que sur les points terre
-;
-;        /RMOUT:select to remove all cell having one corner out of the
-;        plot boundaries (!x.range, !y.range)
-;
-;        + tous les mots clefs de la procedure PLOTS
-;
-; OUTPUTS:none
-;
-; COMMON BLOCKS:common.pro
-;
-; SIDE EFFECTS:
-;
-; RESTRICTIONS:
-;
-; EXAMPLE:
+; @uses
+; common.pro
+; 
+; @examples
 ;
 ;     IDL> plt,indgen(jpi,jpj),/nocontour,/nofill
@@ -49 +51 @@
 ;
 ;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
-;                      
+; @history
+; Sebastien Masson (smasson@lodyc.jussieu.fr)
+;
+; @version
+; $Id$
+;                  
 ;-
 ;------------------------------------------------------------
@@ -68 +74 @@
   ENDIF
 ;---------------------------------------------------------
-  tempsun = systime(1)          ; pour key_performance
+  tempsun = systime(1)          ; For key_performance
 ; to avoid warning message
   oldexcept = !except