Changeset 369 for trunk/SRC/ToBeReviewed

Timestamp:

08/06/08 17:52:18 (16 years ago)

Author:

pinsard

Message:

improvements of some headers

Location:

trunk/SRC/ToBeReviewed/PLOTS

Files:

• LABEL/label.pro (modified) (3 diffs)
• LABEL/label_date.pro (modified) (5 diffs)
• LABEL/label_gmt.pro (modified) (3 diffs)
• LABEL/lataxe.pro (modified) (3 diffs)
• LABEL/lonaxe.pro (modified) (3 diffs)
• axe.pro (modified) (2 diffs)
• legende.pro (modified) (1 diff)
• reinitplt.pro (modified) (1 diff)

trunk/SRC/ToBeReviewed/PLOTS/LABEL/label.pro

@@ -1 @@
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
 ;+
 ;
 ; @file_comments
-; Allows to choose the type of the label we want to use at the time of a contour.
+; Allows to choose the type of the label we want to use at the time of a 
+; contour.
 ;
 ; @categories
@@ -12 +10 @@
 ; @param CAS {in}{required}
 ; Number of the type of the label we want to trace
-;       
+;
 ; @param MIN {in}{required}
 ; Smallest value for the drawing of the contour.
@@ -37 +35 @@
 ;
 ; @uses
-; common.pro
+; <pro>common</pro>
 ;
 ; @history
 ; Sebastien Masson (smasson\@lodyc.jussieu.fr)
-;                       7/5/98
+;                  7/5/98
 ;
 ; @version

trunk/SRC/ToBeReviewed/PLOTS/LABEL/label_date.pro

@@ -1 @@
-;
-; Copyright (c) 1993-1998, Research Systems, Inc.  All rights reserved.
-;       Unauthorized reproduction prohibited.
-
 ;+
 ;
@@ -11 +7 @@
 ; Plotting
 ;
-; @param AXIS {in}{required}
+; @param AXIS {in}
 ;
-; @param INDEX {in}{required}
+; @param INDEX {in}
 ;
-; @param X {in}{required}
+; @param X {in}
 ;
 ; @keyword DATE_FORMAT
 ; a format string which may contain the following:
-; %M for month (3 character abbr)
-; %N for month (2 digit abbr)
+; %M for month (3 characters abbr)
+; %N for month (2 digits abbr)
 ; %D for day of month,
-; %Y for 4 digit year.
+; %Y for 4 digits year.
 ; %Z for last two digits of year.
 ;  For time:
@@ -49 +45 @@
 ;
 ; @uses
-; LABEL_DATE_COM.
 ;
 ; @restrictions
@@ -55 +50 @@
 ;
 ; @examples
+;
 ; For example, to plot from Jan 1, 1993, to July 12, 1994:
-; Start_date = julday(1, 1, 1993)
-; End_date = julday(7, 12, 1994)
-; Dummy = LABEL_DATE(DATE_FORMAT='%N/%D')  ;Simple mm/dd
-; x = findgen(end_date+1 - start_date) + start_date ;Time axis
-; PLOT, x, sqrt(x), XTICKFORMAT = 'LABEL_DATE', XSTYLE=1
-; (Plot with X axis style set to exact.)
-;       
+;
+;  IDL> Start_date = julday(1, 1, 1993)
+;  IDL> End_date = julday(7, 12, 1994)
+;  IDL> ; Simple mm/dd
+;  IDL> Dummy = LABEL_DATE(DATE_FORMAT='%N/%D')
+;  IDL> ;Time axis
+;  IDL> x = findgen(end_date+1 - start_date) + start_date
+;  IDL> ; Plot with X axis style set to exact
+;  IDL> PLOT, x, sqrt(x), XTICKFORMAT = 'LABEL_DATE', XSTYLE=1
+;
 ; Example with times:
-;       For example, to plot from 3PM, Jan 1, 1993, to 5AM, Jan 3,
-;       1993:
-;       Start_date = Julday(1,1,1993)   ;Also starting offset
-;       Start_time = (3+12)/24.         ;Starting_time less offset
-;       End_time = (Julday(1,3,1993) - Start_date) + 5./24. ;Ending
-;               ;date/time - offset, note that the order of operations is
-;               ; important to avoid loss of precision.
-;       Dummy = LABEL_DATE(DATE_FORMAT='%D %M!C%H:%I', $
-;               offset=Start_date)       ;MMM NN <new line> HH:MM format
-;       x = findgen(20) * (End_time - Start_time) / 19 + start_time ;Time axis
-;       PLOT, x, sqrt(x), XTICKFORMAT = 'LABEL_DATE', XSTYLE=1
+;
+; For example, to plot from 3PM, Jan 1, 1993, to 5AM, Jan 3, 1993:
+;
+;  IDL> ; Also starting offset
+;  IDL> Start_date = Julday(1,1,1993)
+;  IDL> ; Starting_time less offset
+;  IDL> Start_time = (3+12)/24.
+;  IDL> End_time = (Julday(1,3,1993) - Start_date) + 5./24.
+;  IDL> ; Ending date/time - offset, note that the order of operations is
+;  IDL> ; important to avoid loss of precision
+;  IDL> ; MMM NN <new line> HH:MM format
+;  IDL> Dummy = LABEL_DATE(DATE_FORMAT='%D %M!C%H:%I', offset=Start_date)
+;  IDL> ;Time axis
+;  IDL> x = findgen(20) * (End_time - Start_time) / 19 + start_time
+;  IDL> PLOT, x, sqrt(x), XTICKFORMAT = 'LABEL_DATE', XSTYLE=1
 ;
 ; @history
-;       DMS, RSI.       April, 1993.    Written.
-;       DMS, RSI.       March, 1997.    Added Time format.
+;     DMS, RSI.     April, 1993.     Written.
+;     DMS, RSI.     March, 1997.     Added Time format.
 ;
 ; Copyright (c) 1993-1998, Research Systems, Inc.  All rights reserved.
-;       Unauthorized reproduction prohibited.
+;     Unauthorized reproduction prohibited.
 ;
 ; @version
@@ -119 +122 @@
         i = i + 1
         c = strmid(fmt, i, 1)   ;The function
-        case c of               ;format character?
+        case c of          ;format character?
             'M' : out = out + month_chr[month-1]
             'N' : out = out + string(format='(i2.2)', month)

trunk/SRC/ToBeReviewed/PLOTS/LABEL/label_gmt.pro

@@ -7 +7 @@
 ;
 ; @param MIN {in}{required}
-; A reel number specifying above what value we want to trace a contour
+; A real number specifying above what value we want to trace a contour
 ;
 ; @param MAX {in}{required}
-; A reel number specifying below what value we want to trace a contour
+; A real number specifying below what value we want to trace a contour
 ;
 ; @param INTERVALLE
@@ -56 +56 @@
       IF finite(min) EQ 0 THEN read, ' Grey shade needs a min,max :', min, max
       ncontour  = fix((max-min)/intervalle)
-      level_z2d = min + intervalle*findgen(Ncontour)
-      max=level_z2d[Ncontour-1]+intervalle
+      level_z2d = min + intervalle*findgen(ncontour)
+      max=level_z2d[ncontour-1]+intervalle
 
       ras = report(['     Number of contour intervals, plotting min & max ' + $
@@ -93 +93 @@
 
       mid_index = max(where(level_z2d LE fldatt.mid))
-      coul = findgen(Ncontour)+49-mid_index +2
+      coul = findgen(ncontour)+49-mid_index +2
 
    ENDELSE

trunk/SRC/ToBeReviewed/PLOTS/LABEL/lataxe.pro

@@ -1 @@
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
 ;+
 ;
 ; @file_comments
-; function called by [XYZ]TICKFORMAT (see the help to see how to use it) to label axes in latitude.
+; function called by [XYZ]TICKFORMAT (see the help to see how to use it) to 
+; label axes in latitude.
 ;
 ; @categories
@@ -15 +13 @@
 ; @param INDEX
 ; It is the tick mark index which starts at 0.
-;       
+;
 ; @param VALUE
 ; It is the default tick mark value (a floating-point number).
@@ -53 +51 @@
    return, nom
 end
-

trunk/SRC/ToBeReviewed/PLOTS/LABEL/lonaxe.pro

@@ -1 @@
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
 ;+
 ;
 ; @file_comments
-; function called by [XYZ]TICKFORMAT (see the help to see how to use it) to label axes in longitude.
+; function called by [XYZ]TICKFORMAT (see the help to see how to use it) to 
+; label axes in longitude.
 ;
 ; @categories
@@ -15 +13 @@
 ; @param INDEX
 ; It is the tick mark index which starts at 0.
-;       
+;
 ; @param VALUE
 ; It is the default tick mark value (a floating-point number).
@@ -52 +50 @@
    return, nom
 end
-

trunk/SRC/ToBeReviewed/PLOTS/axe.pro

@@ -29 +29 @@
 ;
 ; @keyword DIGITSYEAR
-; =2 to use %Z format (2 digits) to code years instead of %Y format.
+; =2 to use %Z format (2 digits) to code years instead of %Y format (4 digits).
 ; See <pro>label_date</pro> for more information on %Z and %Y.
 ;
@@ -36 +36 @@
 ;
 ; @uses
-; common.pro
+; <pro>common</pro>
 ;
 ; @restrictions

trunk/SRC/ToBeReviewed/PLOTS/legende.pro

@@ -28 +28 @@
 ;
 ; @uses
-; common.pro
+; <pro>common</pro>
 ;
 ; @restrictions

trunk/SRC/ToBeReviewed/PLOTS/reinitplt.pro

@@ -28 +28 @@
 ;
 ; @uses
-; common.pro
+; <pro>common</pro>
 ;
 ; @restrictions