Changeset 93 for trunk/SRC/Calendar/monthname.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/monthname.pro (modified) (1 diff)

trunk/SRC/Calendar/monthname.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:monthname
 ;
-; PURPOSE:gives the name of a month
+; gives the name of a month
 ;
-; CATEGORY:
+; @categories calendar
+; 
+; @param number {in}{required}  the month number (from 1 to 12)
 ;
-; CALLING SEQUENCE:name=monthname(number)
-; 
-; INPUTS: number, the month number (from 1 to 12)
+; @file_comments keyword parameters of string function to specify the format of the month (the C format) can be used.
 ;
-; KEYWORD PARAMETERS:those of string fonction to specify the
-;                    format of the month (the C format)
+; @returns the month's name
 ;
-; OUTPUTS: an integer, the month's name
+; @examples 
+; IDL> name=monthname(2)
 ;
-; COMMON BLOCKS:None
-;
-; SIDE EFFECTS:
-;
-; RESTRICTIONS:
-;
-; EXAMPLE:
-;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ;                      1 October 2001
 ;-