Changeset 93 for trunk/SRC/Calendar

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

Location:

trunk/SRC/Calendar

Files:

• date2jul.pro (modified) (2 diffs)
• date2string.pro (modified) (2 diffs)
• daysinmonth.pro (modified) (1 diff)
• jul2date.pro (modified) (1 diff)
• leapyr.pro (modified) (2 diffs)
• monthname.pro (modified) (1 diff)

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
 ;-

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.

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.

trunk/SRC/Calendar/jul2date.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME: jul2date
 ;
-; PURPOSE: gives yyyymmdd date equivalent of a julian day
+; gives yyyymmdd date equivalent of a julian day
 ;
-; CATEGORY: calendar
+; @categories calendar
 ;
-; CALLING SEQUENCE: date = jul2date(jday)
+; @param jday {in}{required} julian day
 ;
-; INPUTS:jday: julian day
+; @returns date in yyyymmdd format
 ;
-; KEYWORD PARAMETERS: None
-;
-; OUTPUTS: date in yyyymmdd format
-;
-; COMMON BLOCKS: None
-;
-; SIDE EFFECTS:
-;
-; RESTRICTIONS:
-;
-; EXAMPLE:
+; @examples 
 ;
 ;    IDL> print, jul2date(julday(12,23,1999))
 ;        19991223
 ;
-; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ;                       June 2005
 ;-

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'

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
 ;-