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

trunk/SRC/Calendar/daysinmonth.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:daysinmonth
 ;
-; PURPOSE:give the nomber of days in a specefic month
+; give the number of days in a specific month
 ;
-; CATEGORY: calandar
+; @categories calendar
 ;
-; CALLING SEQUENCE: ndays = daysinmonth([month[, year]])
 ;
-; INPUTS (optionnal): month and year. Year is used only if the
-;      common variable key_caltype = 'greg'. In that case, month
-;      and year must have the same number of elements. if not
-;      provided, we take month and year from "time" common variable.
+; @param month {in}{optional} 
+; @param year {in}{optional} 
+; Year is used only if the  common variable key_caltype = 'greg'. 
+; In that case, month and year must have the same number of elements. 
+; If not provided, we take month and year from "time" common variable.
 ;
-; KEYWORD PARAMETERS:
+; @returns number of days in a month or -1 in case of error
 ;
-; OUTPUTS:
+; @uses cm_4cal
+;        
+; @examples 
+; IDL> ndays = daysinmonth(2, 2000)
 ;
-; COMMON BLOCKS: cm_4cal
-;        
-; SIDE EFFECTS: return -1 in case of error
-;
-; RESTRICTIONS:
-;
-; EXAMPLE:
-;
-; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ;                       2/7/98
 ; update/review/english/new commons: June 2005 Sebastien Masson.