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

trunk/SRC/Calendar/date2jul.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME: date2jul
 ;
-; PURPOSE: gives julian day equivalent of a date in yyyymmdd format 
+; gives julian day equivalent of a date in yyyymmdd format 
 ;
-; CATEGORY: calendar
+; @categories calendar
 ;
-; CALLING SEQUENCE: jday = juldate(19930124)
+; @param date {in}{required} date in yyyymmdd format
 ;
-; INPUTS: date in yyyymmdd format
-;
-; KEYWORD PARAMETERS:
-;
-;       /GRADS: if  1 <= year <= 49 --> year = 2000 + year
+; @keyword /GRADS {in}{optional} 
+;               if  1 <= year <= 49 --> year = 2000 + year
 ;               if 50 <= year <= 99 --> year = 1900 + year
 ;
-; OUTPUTS:date en jour julien
+; @returns date in julian day
 ;
-; COMMON BLOCKS: none
+; @examples 
 ;
-; SIDE EFFECTS: ?
-;
-; RESTRICTIONS: ?
-;
-; EXAMPLE:
-;
+;    IDL> jday = juldate(19930124)
 ;    IDL> print, date2jul(19931205) EQ julday(12,5,1993) 
 ;       1
@@ -33 +24 @@
 ;       1
 ;
-; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;                       June 2005
 ;-