Changeset 163 for trunk/SRC/Grid/ncdf_meshread.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/ncdf_meshread.pro (modified) (3 diffs)

trunk/SRC/Grid/ncdf_meshread.pro

@@ -22 +22 @@
 ;      lon2 > lon1
 ;      lon2 - lon1 le 360
-;    key_shift will be automaticaly defined according to GLAMBOUNDARY.
+;    key_shift will be automatically defined according to GLAMBOUNDARY.
 ;
 ; @keyword CHECKDAT Suppressed. Use micromeshmask.pro to create an
 ;    appropriate meshmask.
 ;
-; @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
@@ -38 +39 @@
 ;    defined in jpiglo, jpjglo, jpkglo (cm_4mesh common variables)
 ;
-; @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 SHIFT to force the manual definition of key_shift. By
-;    default, key_shift is automaticaly computed according to the
+; @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 SHIFT {default= key_shift is automatically computed according to the glamboundary}
+;    to force the manual definition of key_shift. By
+;    default, key_shift is automatically computed according to the
 ;    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 call
+; @keyword STRCALLING {type=string}
+;    a string containing the calling command used to call
 ;    computegrid (this is used by xxx.pro)
 ;
@@ -65 +69 @@
 ;
 ;  ixminmesh,ixmaxmesh,iyminmesh,iymaxmesh,izminmesh,izmaxmesh must
-;  be defined febore calling ncdf_meshread. if some of those value
+;  be defined before calling ncdf_meshread. if some of those value
 ;  are equal to -1 they will be automatically defined
 ;