Changeset 93 for trunk/SRC/Calendar/date2string.pro

Timestamp:

06/07/06 19:12:14 (18 years ago)

Author:

pinsard

Message:

start to modify headers of Calendar and Utilities *.pro files for bet
ter idldoc output

File:

• trunk/SRC/Calendar/date2string.pro (modified) (2 diffs)

trunk/SRC/Calendar/date2string.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME: date2string
 ;
-; PURPOSE: create a nice and readable format to print a date
+; create a nice and readable format to print a date
 ;
-; CATEGORY: calendar/string
+; @categories calendar, string
 ;
-; CALLING SEQUENCE: nice_date = date2string(yyyymmdd)
-; 
-; INPUTS: yyyymmdd the date in the format 
-;         yearyearyearyearmonthmonthdayday
+; @param yyyymmdd {in}{required} the date in the format yyyymmdd
 ;
-; KEYWORD PARAMETERS:those of string fonction to specify the
-;                    format of the month (the C format)
+; @file_comments keyword parameters of string function to specify the format of the month (the C format) can be used
 ;
-; OUTPUTS: a string containing the date in a easy readable format
+; @returns a string containing the date in a easy readable format
 ;
-; COMMON BLOCKS:none
-;
-; SIDE EFFECTS:?
-;
-; RESTRICTIONS:?
-;
-; EXAMPLE:
+; @examples 
 ;
 ;    IDL> print, date2string(19900123)
@@ -32 +21 @@
 ;    JAN 23, 1990
 ;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ; Creation ???
 ; update/review June 2005 Sebastien Masson.