Changeset 163 for trunk/SRC/ToBeReviewed/PLOTS/DIVERS/checkfield.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/ToBeReviewed/PLOTS/DIVERS/checkfield.pro (modified) (6 diffs)

trunk/SRC/ToBeReviewed/PLOTS/DIVERS/checkfield.pro

@@ -6 +6 @@
 ; 
 ; 
-; @param TYPE {in}{required}
+; @param TYPE {in}{required}{type=string}
 ; A string of two characters specifying the type of plot we do
 ;
-; @param N1 {in}{required}
+; @param N1 {in}{required}{type=integer}
 ; Number of elements in the first dimension
 ;
-; @param N2 {in}{required}
+; @param N2 {in}{required}{type=integer}
 ; Number of elements in the second dimension
 ;
-; @param NAME {in} {optional}
-; It is a string giving the name of the file to be opened. If NAME
+; @param NAME {in}{optional}{type=string}
+; It gives the name of the file to be opened. If NAME
 ; does not contain the separating character of directories ('/' under
 ; unix for example), the file will be looked for in the current directory.
@@ -51 +51 @@
 ; 
 ; 
-; @param TYPE {in}{required}
+; @param TYPE {in}{required}{type=string}
 ; A string of two characters specifying the type of plot we do
 ;
@@ -101 +101 @@
 ; 
 ; 
-; @param TYPE {in}{required}
+; @param TYPE {in}{required}{type=string}
 ; A string of two characters specifying the type of plot we do
 ;
@@ -157 +157 @@
 ; Graphics
 ; 
-; @param FIELD {in}{required}
-; A field respecting litchamp.pro's criterions. See IDL>xhelp,'litchamp'
+; @param FIELD {in}{required}{type=field}
+; It respect litchamp.pro's criterions. See IDL>xhelp,'litchamp'
 ;
 ; @param PROCEDURE {in}{required}
@@ -169 +169 @@
 ;
 ;
-; @keyword BOXZOOM 
+; @keyword BOXZOOM {type=vector}
 ; Vector indicating the geographic zone on which we want to cut the map. 
 ;  If BOXZOOM has :
@@ -181 +181 @@
 ;
 ; @keyword WDEPTH
-; to specify that the field is at W depth instad of T 
+; to specify that the field is at W depth instead of T 
 ; depth (automatically activated if vargrid eq 'W')
 ; 
-; @keyword VECTEUR
+; @keyword VECTEUR{type=vetcor}
 ; It is a structure composed by 2 elements containing the 2 fields U
 ; and V of values of the zonal and meridian component of the vector of the fields
 ; to draw. These fields can be an array or a structure.
 ;       For example: vecteur={matriceu:lec('unsurface'),matricev:lec('vnsurface')}
-;       Comment: name of elements of vectors are inconsenquential.
+;       Comment: name of elements of vectors are inconsequential.
 ;       vecteur={u:lec('unsurface'),v:lec('vnsurface')} is also appropriated.
 ;