Changeset 163 for trunk/SRC/ToBeReviewed/PLOTS/DESSINE/pltbase.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/DESSINE/pltbase.pro (modified) (3 diffs)

trunk/SRC/ToBeReviewed/PLOTS/DESSINE/pltbase.pro

@@ -20 +20 @@
 ; Axis. Vector or array of the same size that z2d. This is the coordinate of z2d on y.
 ;
-; @param MASK {in}{required}
+; @param MASK {in}{required}{type=array}
 ; It is the array who mask z2d (with 0s on points we want to mask and 1s on others). 
 ; If z2d is not masked, put this argument equal to 1.
@@ -32 +32 @@
 ; This is the coordinate of mask on y.
 ;
-; @param LEVELS {in}{optional}
+; @param LEVELS {in}{optional}{type=vector}
 ; Vectors which contain levels needed at the contour. 
 ; If it is not given, we take 20 levels between the min and the max.
 ;  
-; @param COLORS {in}{optional}
+; @param COLORS {in}{optional}{type=vector}
 ; Vectors which contain colors needed at the contour. 
 ; If it is not given, we take 20 levels between the min and the max.
@@ -50 +50 @@
 ; with filling in color 
 ;
-; @keyword /CONT_NOFILL 
+; @keyword CONT_NOFILL 
 ; Activate it not to fill the point mask to let them transparent! 
 ; Comment: Nevertheless, we trace mask's contour.
 ;
-; @keyword CONT_COLOR 
-; The color of the continent. defaut value is
-;        (!d.n_colors - 1) < 255 => white
-;
-; @keyword /DESSTRICHAMP 
+; @keyword CONT_COLOR {default= (!d.n_colors - 1) < 255 =>white}
+; The color of the continent.
+;
+; @keyword DESSTRICHAMP 
 ; To draw the triangulation which is used to make field's contours. 
 ;
-; @keyword /DESSTRIMASK 
+; @keyword DESSTRIMASK 
 ; To draw the triangulation which is used to make mask's contours.
 ; 
-; @keyword /FORPLT 
+; @keyword FORPLT 
 ; To activate if we want that the drawing of coast be realized by tracecote rather than tracemask.
 ;
-; @keyword I_COLORS 
-; It is a vector specifing the colors to use to trace contours. 
+; @keyword I_COLORS {type=vector}
+; It is a vector specifying the colors to use to trace contours. 
 ; It is the same thing that c_colors which act on contours.
 ;
-; @keyword MORE 
+; @keyword MORE {default=10}
 ; Number to give to avoid style's bugs:
 ;  % Out of range subscript encountered: <LONG      Array[38911]>.
 ;  % Execution halted at:  PLTBASE           151
-;             By default more=10 If the bug still exist, increase the value of more! 
+;             If the bug still exist, increase the value of more! 
 ; (The explanation and the justification of this method do not have scientific bases yet...).
 ;
-; @keyword /NOFILL
+; @keyword NOFILL
 ; To make just isolines.
 ;
-; @keyword /NOCONTOUR
+; @keyword NOCONTOUR
 ; To make just colors.
 ;
-; @keyword /UNSUR2 To trace one isoline on two.
-;
-; @keyword UNLABSUR 
-; Is an integer n. specifying we only label one contour on two
+; @keyword UNSUR2
+; To trace one isoline on two.
+;
+; @keyword UNLABSUR {type=integer}
+; I specify we only label one contour on two.
 ;
 ; @keyword CONTOUR