Changeset 163 for trunk/SRC/ToBeReviewed/PLOTS/DESSINE/pltsc.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/pltsc.pro (modified) (1 diff)

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

@@ -1 +1 @@
 ;+
+; @file_comments
+;
+;
+; @categories
+;
+;
+; @param TAB1
+;
+;
+; @param TAB2
+;
+;
+; @param MIN1
+;
+;
+; @param MAX1
+;
+;
+; @param MIN2
+;
+;
+; @param MAX2
+;
+;
+; @param VARNAME2
+;
+;
+; @keyword BOXZOOM
+; 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]]
+; 2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
+; 4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])]
+; 5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]]
+; 6 elements: The extraction is made on Boxzoom
+;
+; @keyword COL1D
+;
+;
+; @keyword STY1D
+;
+;
+; @keyword OV1D
+;
+;
+; @keyword _EXTRA
+; Used to pass your keywords
+;
+; @returns
+;
+;
+; @uses
+;
+;
+; @restrictions
+;
+;
+; @examples
+;
+;
+; @history
+;
+;
+; @version
+; $Id$
 ;
 ; @todo seb
 ;
 ;-
+;
 PRO  pltsc,tab1,tab2, min1, max1, min2, max2, varname2, BOXZOOM = boxzoom, $
            COL1D=col1d,STY1D=sty1d,OV1D=ov1d, _extra = ex
-;
 ; scatter plot (inspired from plt1d)
 ;