Changeset 126 for trunk/SRC

Timestamp:

07/06/06 16:13:57 (18 years ago)

Author:

pinsard

Message:

improvements of Calendar/*.pro header

Location:

trunk/SRC/Calendar

Files:

• date2jul.pro (modified) (2 diffs)
• date2string.pro (modified) (2 diffs)
• daysinmonth.pro (modified) (3 diffs)
• jul2date.pro (modified) (2 diffs)
• leapyr.pro (modified) (4 diffs)
• monthname.pro (modified) (2 diffs)

trunk/SRC/Calendar/date2jul.pro

@@ -4 +4 @@
 ;+
 ;
-; @file_comments gives julian day equivalent of a date in yyyymmdd format 
+; @file_comments 
+; gives julian day equivalent of a date in yyyymmdd format
 ;
 ; @categories calendar
@@ -10 +11 @@
 ; @param date {in}{required} date in yyyymmdd format
 ;
-; @keyword /GRADS {in}{optional} 
-;               if  1 <= year <= 49 --> year = 2000 + year
-;               if 50 <= year <= 99 --> year = 1900 + year
+; @keyword GRADS {in}{optional}
+; if  1 <= year <= 49 --> year = 2000 + year
+; if 50 <= year <= 99 --> year = 1900 + year
 ;
 ; @returns date in julian day
 ;
-; @examples 
+; @examples
 ;
-;    IDL> jday = juldate(19930124)
-;    IDL> print, date2jul(19931205) EQ julday(12,5,1993) 
+; IDL> jday = juldate(19930124)
+; IDL> print, date2jul(19931205) EQ julday(12,5,1993)
 ;       1
-;    IDL> print, date2jul(931205,/grads) EQ julday(12,5,1993) 
+; IDL> print, date2jul(931205,/grads) EQ julday(12,5,1993)
 ;       1
 ;

trunk/SRC/Calendar/date2string.pro

@@ -4 +4 @@
 ;+
 ;
-; @file_comments create a nice and readable format to print a date
+; @file_comments
+; create a nice and readable format to print a date
 ;
 ; @categories calendar, string
@@ -16 +17 @@
 ; @returns a string containing the date in a easy readable format
 ;
-; @examples 
+; @examples
 ;
-;    IDL> print, date2string(19900123)
+; IDL> print, date2string(19900123)
 ;    Jan 23, 1990
-;    IDL> print, date2string(19900123, format = '(C(CMOA))')
+; IDL> print, date2string(19900123, format = '(C(CMOA))')
 ;    JAN 23, 1990
 ;

trunk/SRC/Calendar/daysinmonth.pro

@@ -4 +4 @@
 ;+
 ;
-; @file_comments give the number of days in a specific month
+; @file_comments
+; give the number of days in a specific month
 ;
 ; @categories calendar
 ;
-; @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. 
+; @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.
 ;
@@ -17 +18 @@
 ;
 ; @uses cm_4cal
-;        
-; @examples 
+;
+; @examples
 ; IDL> ndays = daysinmonth(2, 2000)
 ;
@@ -60 +61 @@
       days_in_mth = [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
       return, days_in_mth[month-1] + leapyr(year)*(month EQ 2)
-    END 
+    END
     ELSE:return, report('only 3 types of calendar are accepted: greg, 360d and noleap')
   ENDCASE
 
-END 
+END

trunk/SRC/Calendar/jul2date.pro

@@ -4 +4 @@
 ;+
 ;
-; @file_comments gives yyyymmdd date equivalent of a julian day
+; @file_comments
+; gives yyyymmdd date equivalent of a julian day
 ;
 ; @categories calendar
@@ -12 +13 @@
 ; @returns date in yyyymmdd format
 ;
-; @examples 
+; @examples
 ;
-;    IDL> print, jul2date(julday(12,23,1999))
+; IDL> print, jul2date(julday(12,23,1999))
 ;        19991223
 ;

trunk/SRC/Calendar/leapyr.pro

@@ -2 +2 @@
 ;+
 ;
-; @file_comments determine whether the input year is a leap year or not
+; @file_comments
+; 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)
@@ -10 +11 @@
 ; @param year {in}{required} year to be tested as a leap year
 ;
-; @returns 0 then not a leap year 
+; @returns 0 then not a leap year
 ;          1 then year is a leap year
 ;
@@ -25 +26 @@
 ;       November 2004: correction for century years... S. Masson;
 ;
-;       Every year divisible by 4 is a leap year. 
-;       But every year divisible by 100 is NOT a leap year 
+;       Every year divisible by 4 is a leap year.
+;       But every year divisible by 100 is NOT a leap year
 ;       Unless the year is also divisible by 400, then it is still a
 ;       leap year.
 ;       This means that year 1800, 1900, 2100, 2200, 2300 and 2500 are
-;       NOT leap years, while year 2000 and 2400 are leap years. 
+;       NOT leap years, while year 2000 and 2400 are leap years.
 ;       + supress the automatic change 89 -> 1989
 ;
@@ -49 +50 @@
   IF n_elements(key_caltype) EQ 0 THEN key_caltype = 'greg'
 ;
-  IF key_caltype NE 'greg' THEN BEGIN 
+  IF key_caltype NE 'greg' THEN BEGIN
     sd = size(yr, /dimensions)
     IF sd[0] EQ 0 THEN return, 0b ELSE return, bytarr(size(yr, /dimensions))

trunk/SRC/Calendar/monthname.pro

@@ -4 +4 @@
 ;+
 ;
-; @file_comments gives the name of a month
+; @file_comments
+; gives the name of a month
 ;
 ; @categories calendar
-; 
+;
 ; @param mm1 {in}{required}  the month number (from 1 to 12)
 ;
@@ -16 +17 @@
 ; @returns the month's name
 ;
-; @examples 
+; @examples
 ; IDL> name=monthname(2)
 ;