Changeset 163 for trunk/SRC/ToBeReviewed/PLOTS/VECTEUR

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)

Location:

trunk/SRC/ToBeReviewed/PLOTS/VECTEUR

Files:

• ajoutvect.pro (modified) (2 diffs)
• vecteur.pro (modified) (5 diffs)
• velovect.pro (modified) (3 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.

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

@@ -26 +26 @@
 FUNCTION cv_cm2normal, angle
 ;
-; Give the lenth in normal coordinates of a trait oriented of an angle
+; Give the length in normal coordinates of a trait oriented of an angle
 ; by rapport at the x axis and which must do 1 cm on the drawing.
 ; Angle can be an array.
@@ -35 +35 @@
 ;
 @common
-; What is the lenth in normal coordinates of a trait which will do 1 cm
+; What is the length in normal coordinates of a trait which will do 1 cm
 ; on the paper an which is parallel to x?
   mipgsz = min(page_size, max = mapgsz)
@@ -42 +42 @@
    cm_en_normal = 1./sizexfeuille
 ;
-; If the aspect rapport of the window is not equal to 1, the lenth in
+; If the aspect rapport of the window is not equal to 1, the length in
 ; normalized coordinates of  a trait of 1 cm vary following the polar
 ; angle of this trait.
@@ -134 +134 @@
 ; for example when we trace only one vector on two).
 ;
-; @keyword CMREF
-; The lenth in cm that must measure the arrow normed normeref. By default, 
-; it is ajusted t othe drawing and included between .5 and 1.5 cm.
+; @keyword CMREF {default=between .5 and 1.5 cm}
+; The length in cm that must measure the arrow normed normeref. By default, 
+; it is adjusted to other drawing and included between .5 and 1.5 cm.
 ;
 ; @keyword MISSING
@@ -145 +145 @@
 ; The norme of the reference arrow.
 ;
-; @keyword VECTCOLOR
+; @keyword VECTCOLOR {default=0}
 ; The color of the arrow. Black by default (color 0)
 ; 
-; @keyword VECTTHICK
-; The thick of the arrow. 1 by default 
+; @keyword VECTTHICK {default=1}
+; The thick of the arrow. 
 ;
 ; @keyword VECTREFPOS
-; Vector composed of 2 elements specifing the position on DATA coordinates 
-; from de begining of the reference vector. By default at the right bottom 
+; Vector composed of 2 elements specifying the position on DATA coordinates 
+; from the beginning of the reference vector. By default at the right bottom 
 ; of the drawing.
 ;

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

@@ -27 +27 @@
 ;       ATAN2(V[i,j],U[i,j]).
 ;
-; @param X {in}{optional}
-; Optional abcissae values.  X must be a vector with a length 
+; @param X {in}{optional}{type=vector}
+; Optional abscissa values.  X must be a vector with a length 
 ; equal to the first dimension of U and V.
 ;
-; @param Y {in}{optional}
+; @param Y {in}{optional}{type=vector}
 ; Optional ordinate values.  Y must be a vector with a length
 ; equal to the first dimension of U and V.
@@ -43 +43 @@
 ; points.  Has effect only if MISSING is specified.
 ;
-; @keyword LENGTH
+; @keyword LENGTH {default=1.0}
 ; Length factor.  The default of 1.0 makes the longest (U,V)
 ; vector the length of a cell.
@@ -95 +95 @@
 ;-
 ;
-PRO VELOVECT,U,V,X,Y, Missing = Missing, Length = length, Dots = dots,  $
+PRO velovect,U,V,X,Y, Missing = Missing, Length = length, Dots = dots,  $
         Color=color, CLIP=clip, NOCLIP=noclip, OVERPLOT=overplot, _EXTRA=extra
 ;