Changeset 93 for trunk/SRC/Calendar/leapyr.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/leapyr.pro (modified) (2 diffs)

trunk/SRC/Calendar/leapyr.pro

@@ -1 +1 @@
 ;-----------------------------------------------------------------
-function leapyr, year
 ;+
-; NAME:                 leapyr
 ;
-; PURPOSE:              determine whether the input year is a leap year or not
-;                       Very useful for finding number of days in a year.
-;                       eg. NUM_DAYS_IN_YR = 365 + leapyr(year)
+; determine whether the input year is a leap year or not
+; Very useful for finding number of days in a year.
+; eg. NUM_DAYS_IN_YR = 365 + leapyr(year)
 ;
-; CATEGORY:             Utility
+; @categories calendar
 ;
-; CALLING SEQUENCE:     result = leapyr(year)
+; @param year {in}{required} year to be tested as a leap year
 ;
-; INPUTS:               year    = test if year is a leap year 
+; @returns 0 then not a leap year 
+;          1 then year is a leap year
 ;
-; OUTPUTS:              result  = 0 then not a leap year
-;                               = 1 then year is a leap year
+; @uses cm_4cal
 ;
-; COMMON BLOCKS: cm_4cal
+; @examples
+; IDL> result = leapyr(2000)
 ;
-; SIDE EFFECTS:
-;       none.
-; MODIFICATION HISTORY:
+; @history
 ;
-;       Originally Written by: Trevor Harris, Physics Dept., University of Adelaide,
-;               20/09/88
+; Originally Written by: Trevor Harris, Physics Dept., University of Adelaide,
+;20/09/88
 ;
 ;       November 2004: correction for century years... S. Masson;
@@ -40 +37 @@
 ;-
 ;------------------------------------------------------------
+function leapyr, year
 ; include commons
 @cm_4cal
-;------------------------------------------------------------   
   yr = long(year)
   IF n_elements(key_caltype) EQ 0 THEN key_caltype = 'greg'