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

Timestamp:

06/29/06 16:59:33 (18 years ago)

Author:

pinsard

Message:

correction of some *.pro using aspell list; introduction of default idldoc syntax

File:

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

trunk/SRC/Grid/computegrid.pro

@@ -66 +66 @@
 ;       will be add to the default computations
 ;
-; @keyword GLAMBOUNDARY a 2 elements vector, [lon1,lon2], the longitute
+; @keyword GLAMBOUNDARY a 2 elements vector, [lon1,lon2], the longitude
 ;       boundaries that should be used to visualize the data.
 ;       we must have lon2 > lon1 and lon2 - lon1 le 360
@@ -91 +91 @@
 ;
 ; @keyword SHIFT = scalar to force the manual definition of key_shift. By
-;       debault, key_shift is automaticaly computed according to
+;       default, key_shift is automaticaly computed according to
 ;       glamboundary (when defined) by using the FIRST LINE of glamt. if
 ;       key_periodic=0 then in any case key_shift = 0. 
@@ -98 +98 @@
 ;       call computegrid (this is used by xxx.pro)
 ;
-; @keyword STRIDE  a 3 elements vector to specify the stride in x, y, z
-;       direction. Default definition is [1, 1, 1]. The resulting value
+; @keyword STRIDE {default=[1, 1, 1]} a 3 elements vector to specify the stride in x, y, z
+;       direction. The resulting value
 ;       will be stored in the common (cm_4mesh) variable key_stride
 ;
@@ -119 +119 @@
 ;       using this keyword forces key_onearth=0
 ;
-; @keyword XMINMESH 
-; @keyword YMINMESH 
-; @keyword ZMINMESH 
+; @keyword XMINMESH {default=0L}
+; @keyword YMINMESH {default=0L} 
+; @keyword ZMINMESH {default=0L} 
 ;       to define the common variables i[xyz]minmesh
 ;       used to define the grid only in a zoomed part of the original
-;       grid. Defaut values are 0L, max value is [XYZ]MAXMESH
-;
-; @keyword XMAXMESH 
-; @keyword YMAXMESH 
-; @keyword ZMAXMESH 
+;       grid. max value is [XYZ]MAXMESH
+;
+; @keyword XMAXMESH {default=jpiglo-1}
+; @keyword YMAXMESH {default=jpjglo-1}
+; @keyword ZMAXMESH {default=jpkglo-1}
 ;       to define the common variables i[xyz]maxmesh
 ;       used to define the grid only in a zoomed part of the original
-;       grid. Defaut values are jp[ijk]glo-1, max value is
-;       jp[ijk]glo-1. if [XYZ]MAXMESH is negative, then we define
-;       i[xyz]maxmesh as jp[ijk]glo - 1 + [XYZ]MAXMESH instead of
-;       [XYZ]MAXMESH    
+;       grid. max value is jp[ijk]glo-1. 
+;       if [XYZ]MAXMESH is negative, then we define i[xyz]maxmesh as 
+;       jp[ijk]glo - 1 + [XYZ]MAXMESH instead of [XYZ]MAXMESH   
 ;
 ; @keyword FBASE2TBASE
@@ -377 +376 @@
     2:glamt = glamt[ixminmesh:ixmaxmesh, iyminmesh:iymaxmesh]
   ENDCASE
-; keep 2d array even with degenereted dimension
+; keep 2d array even with degenerated dimension
   IF jpj EQ 1 THEN glamt = reform(glamt, jpi, jpj, /over)
 ;
@@ -407 +406 @@
     2:gphit = gphit[ixminmesh:ixmaxmesh, iyminmesh:iymaxmesh]
   ENDCASE
-; keep 2d array even with degenereted dimension
+; keep 2d array even with degenerated dimension
   IF jpj EQ 1 THEN gphit = reform(gphit, jpi, jpj, /over) 
 ;
@@ -490 +489 @@
 ;====================================================
 ;
-; definition of key_shift by shiftting the array to have the min
+; definition of key_shift by shifting the array to have the min
 ; values of glamt[*, 0] in glamt[0, 0]
 ;
@@ -924 +923 @@
 ;====================================================
 ;
-; defaut mask eq 1
+; default mask eq 1
   if NOT keyword_set(mask) then mask = -1
 ;