Changeset 163 for trunk/SRC/Grid/computegrid.pro

Timestamp:

08/29/06 14:59:46 (18 years ago)

Author:

navarro

Message:

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)

File:

• trunk/SRC/Grid/computegrid.pro (modified) (3 diffs)

trunk/SRC/Grid/computegrid.pro

@@ -63 +63 @@
 ;
 ; @keyword FULLCGRID activate to specify that you want to compute
-;       all the paremeters of a C grid. Computation of glam[uv],
+;       all the parameters of a C grid. Computation of glam[uv],
 ;       gphi[uv], e1[uvf], e2[uvf], [uv]maskred and fmaskred[xy]
 ;       will be add to the default computations
@@ -76 +76 @@
 ; @keyword MASK to specify the mask with a 2 or 3 dimension array
 ;
-; @keyword ONEARTH = 0 or 1 to force the manual definition of
+; @keyword ONEARTH {default= key_onearth=1}
+;       = 0 or 1 to force the manual definition of
 ;       key_onearth (to specify if the data are on earth -> use longitude
-;       /latitude etc...). By default, key_onearth = 1.
+;       /latitude etc...).
 ;       note that ONEARTH = 0 forces PERIODIC = 0, SHIFT = 0,
 ;       and is cancelling GLAMBOUNDARY
 ;
-; @keyword PERIODIC = 0 or 1 to force the manual definition of
-;       key_periodic. By default, key_periodic is automaticaly
-;       computed by using the first line of glamt.
+; @keyword PERIODIC {default=key_periodic is automatically computed by using the first line of glamt}
+;       = 0 or 1 to force the manual definition of key_periodic.
 ;
 ; @keyword PLAIN force PERIODIC = 0, SHIFT = 0, STRIDE = [1, 1, 1] and
@@ -92 +92 @@
 ;
 ; @keyword SHIFT = scalar to force the manual definition of key_shift. By
-;       default, key_shift is automaticaly computed according to
+;       default, key_shift is automatically computed according to
 ;       glamboundary (when defined) by using the FIRST LINE of glamt. if
 ;       key_periodic=0 then in any case key_shift = 0.
 ;
-; @keyword STRCALLING a string containing the calling command used to
+; @keyword STRCALLING {type=string}
+;       a string containing the calling command used to
 ;       call computegrid (this is used by xxx.pro)
 ;