Changeset 163 for trunk/SRC/ToBeReviewed/PLOTS/VECTEUR/ajoutvect.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/VECTEUR/ajoutvect.pro (modified) (2 diffs)

trunk/SRC/ToBeReviewed/PLOTS/VECTEUR/ajoutvect.pro

@@ -10 +10 @@
 ; Graphics
 ;
-; @param VECTEUR {in}{required}
-; It is a structure with 2 elements containing we 2 matrixes U and V of 
-; values of the zonal and meridian component of the fiel of vectors to 
+; @param VECTEUR {in}{required}{type=vector}
+; It is a structure with 2 elements containing we 2 matrices U and V of 
+; values of the zonal and meridian component of the field of vectors to 
 ; be traced.
 ;      For ex:
@@ -19 +19 @@
 ;       vecteur={u:lec('unsurface'),v:lec('vnsurface')} goes well too.
 ;
-; @keyword UNVECTSUR
+; @keyword UNVECTSUR {type=scalar or array}
 ; It is a scalar n or an array with 2 elements [n1,n2].
 ; In the first case, we will trace a vector on n following x and y.