Changeset 378 for trunk/SRC/ToBeReviewed/PLOTS/DIVERS/checkfield.pro

Timestamp:

08/12/08 14:35:46 (16 years ago)

Author:

pinsard

Message:

improvements of headers (typo, links, paragraphes, etc)

File:

• trunk/SRC/ToBeReviewed/PLOTS/DIVERS/checkfield.pro (modified) (4 diffs)

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

@@ -15 +15 @@
 ;
 ; @param NAME {in}{optional}{type=string}
-; It gives the name of the file to be opened. If NAME
+; 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.
@@ -142 +144 @@
 ;
 ; @param FIELD {in}{required}{type=field}
-; It respect <pro>litchamp</pro>'s criterions. See IDL>xhelp,'litchamp'
+; It respect <pro>litchamp</pro>'s criterions.
 ;
 ; @param PROCEDURE {in}{required}
@@ -152 +154 @@
 ; @keyword BOXZOOM {type=vector}
 ; Vector indicating the geographic zone on which we want to cut the map.
+;
 ;  If BOXZOOM has :
 ; 1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
@@ -168 +171 @@
 ; @keyword VECTEUR{type=vector}
 ; 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 inconsequential.
-;       vecteur={u:lec('unsurface'),v:lec('vnsurface')} is also appropriated.
+; 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 inconsequential.
+;  vecteur={u:lec('unsurface'),v:lec('vnsurface')} is also appropriated.
 ;
 ; @keyword _EXTRA