Changeset 142 for trunk/SRC/ToBeReviewed/PLOTS/LABEL/label_date.pro

Timestamp:

07/21/06 14:47:49 (18 years ago)

Author:

navarro

Message:

english and nicer header (2a)

File:

• trunk/SRC/ToBeReviewed/PLOTS/LABEL/label_date.pro (modified) (3 diffs)

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

@@ -1 @@
-; $Id$
 ;
 ; Copyright (c) 1993-1998, Research Systems, Inc.  All rights reserved.
@@ -5 +4 @@
 
 ;+
-; NAME:
-;       LABEL_DATE
 ;
-; PURPOSE:
-;       This function labels axes with dates and times.
+; @file_comments
+; This function labels axes with dates and times.
 ;
-; CATEGORY:
-;       Plotting.
+; @categories
+; Plotting.
 ;
-; CALLING SEQUENCE:
-;       To set up:
-;               dummy = LABEL_DATE(DATE_FORMAT='string')
-;       To use:
-;               PLOT, x, y, XTICKFORMAT='LABEL_DATE'
+; @param AXIS {in}{required}
 ;
-; INPUTS:
-;       No explicit user defined inputs. When called from the plotting
-;       routines, the input parameters are (Axis, Index, Value)
+; @param INDEX {in}{required}
 ;
-; KEYWORD PARAMETERS:
-;       DATE_FORMAT: a format string which may contain the following:
-;                      %M for month (3 character abbr)
-;                      %N for month (2 digit abbr)
-;                      %D for day of month,
-;                      %Y for 4 digit year.
-;                      %Z for last two digits of year.
-;            For time:
-;                      %H for Hours, 2 digits.
-;                      %I for mInutes, 2 digits.
-;                      %S for Seconds, 2 digits.
-;                      %% is %.
-;                    Other characters are passed directly thru.
-;                    For example, '%M %D, %Y' prints DEC 11, 1993
-;                      '%M %2Y' yields DEC 93
-;                      '%D-%M' yields 11-DEC
-;                      '%D/%N/%Y' yields 11/12/1993
-;                      '%M!C%Y' yields DEC on the top line, 1993 on
-;                      the bottom (!C is the new line graphic command).
+; @param X {in}{required}
 ;
-;       MONTHS:      The names of the months, a twelve element string array.
-;                    If omitted, use Jan, Feb, ..., Dec.
+; @keyword DATE_FORMAT
+; a format string which may contain the following:
+; %M for month (3 character abbr)
+; %N for month (2 digit abbr)
+; %D for day of month,
+; %Y for 4 digit year.
+; %Z for last two digits of year.
+;  For time:
+; %H for Hours, 2 digits.
+; %I for mInutes, 2 digits.
+; %S for Seconds, 2 digits.
+; %% is %.
+;  Other characters are passed directly thru.
+; For example, '%M %D, %Y' prints DEC 11, 1993
+; '%M %2Y' yields DEC 93
+; '%D-%M' yields 11-DEC
+; '%D/%N/%Y' yields 11/12/1993
+; '%M!C%Y' yields DEC on the top line, 1993 on
+; the bottom (!C is the new line graphic command).
 ;
-;       OFFSET:      An optional starting offset of the plot.
-;               Unfortunately, single precision floating point is not accurate
-;               enough to properly represent Julian times.  This offset, which
-;               may be double precision, contains an offset that is added to
-;               all x values, before conversion to Julian date and time.
-
-; OUTPUTS:
-;       The date string to be plotted.
+; @keyword MONTHS
+; The names of the months, a twelve element string array.
+; If omitted, use Jan, Feb, ..., Dec.
 ;
-; COMMON BLOCKS:
-;       LABEL_DATE_COM.
+; @keyword OFFSET
+; An optional starting offset of the plot.
+; Unfortunately, single precision floating point is not accurate
+; enough to properly represent Julian times.  This offset, which
+; may be double precision, contains an offset that is added to
+; all x values, before conversion to Julian date and time.
 ;
-; RESTRICTIONS:
-;       Only one date axis may be simultaneously active.
+; @uses
+; LABEL_DATE_COM.
 ;
-; PROCEDURE:
-;       Straightforward.
+; @restrictions
+; Only one date axis may be simultaneously active.
 ;
-;       For an alternative way to label a plot axis with dates, refer to
-;       the C() format code accepted within format strings (applicable via
-;       the [XYZ]TICKFORMAT keywords).  This new format code was 
-;       introduced in IDL 5.2.
-;
-; EXAMPLE:
-;       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.)
+; @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.)
 ;       
 ; Example with times:
@@ -92 +76 @@
 ;       PLOT, x, sqrt(x), XTICKFORMAT = 'LABEL_DATE', XSTYLE=1
 ;
-; MODIFICATION HISTORY:
+; @history
 ;       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.
+;
+; @version
+; $Id$
+;
 ;-
-
+;-----------------------------------------------------------------------------
 FUNCTION LABEL_DATE, axis, index, x, DATE_FORMAT = format, MONTHS = months, $
               OFFSET= offs, _EXTRA = ex