Changeset 231 for trunk/SRC/Calendar/caldat.pro

Timestamp:

03/19/07 18:15:51 (17 years ago)

Author:

pinsard

Message:

improvements/corrections of some *.pro headers

File:

• trunk/SRC/Calendar/caldat.pro (modified) (7 diffs)

trunk/SRC/Calendar/caldat.pro

@@ -3 +3 @@
 ; @file_comments
 ; Return the calendar date and time given julian date.
-; This is the inverse of the function JULDAY.
-; 3 calendars are available according to the value of key_caltype 
+; This is the inverse of the function
+; <pro>julday</pro>.
+; 3 calendars are available according to the value of key_caltype
 ; (variable of the common file cm_4cal): 'greg', '360d', 'noleap'
 ;
 ; @categories Calendar
 ;
-; @param JULIAN {in}{required} 
+; @param JULIAN {in}{required} {type=long integer}
 ; contains the Julian Day Number (which begins at noon) of the
-; specified calendar date.  It should be a long integer.
-;
-; @param MONTH {out} 
+; specified calendar date.
+;
+; @param MONTH {out} {type=integer}
 ; Number of the desired month (1 = January, ..., 12 = December).
 ;
-; @param DAY {out} 
+; @param DAY {out} {type=integer}
 ; Number of day of the month.
 ;
-; @param YEAR {out} 
+; @param YEAR {out} {type=integer}
 ; Number of the desired year.
 ;
-; @param HOUR {out} 
+; @param HOUR {out} {type=integer}
 ; Hour of the day
 ;
-; @param Minute {out} 
+; @param Minute {out} {type=integer}
 ; Minute of the day
 ;
-; @param Second {out} 
+; @param Second {out} {type=float}
 ; Second (and fractions) of the day.
 ;
-; @keyword NDAYSPM {default=30} 
-; To use a calendar with fixed number of days per months.
+; @keyword NDAYSPM {type=integer} {default=30}
+; To use a calendar with fixed number of days per month.
 ; see also the use of key_caltype (variable of the common file cm_4cal)
 ;
 ; @uses cm_4cal
 ;
-; @restrictions 
-; Accuracy using IEEE double precision numbers is approximately 1/10000th of a 
+; @restrictions
+; Accuracy using IEEE double precision numbers is approximately 1/10000th of a
 ; second.
 ;
-; @history 
+; @history
 ; Translated from "Numerical Recipies in C", by William H. Press,
 ; Brian P. Flannery, Saul A. Teukolsky, and William T. Vetterling.
@@ -55 +56 @@
 ; AB, 3 January 2000, Make seconds output as DOUBLE in array output.
 ;
-; Sebastien Masson, May 2006, add different calendat with key_caltype 
+; Sebastien Masson, May 2006, add different calendar with key_caltype
 ; (variable of the common file cm_4cal)
 ;
-; @version $Id$
+; @version
+; $Id$
 ;-
+;
 pro caldat, julian, month, day, year, hour, minute, second, NDAYSPM = ndayspm
-;------------------------------------------------------------
+;
 @cm_4cal
-;------------------------------------------------------------
-  COMPILE_OPT idl2
+;
+  compile_opt idl2, strictarrsubs
 
   ON_ERROR, 2                   ; Return to caller if errors
@@ -112 +115 @@
       year = year - (year LE 0)
 
-    END 
+    END
     '360d':BEGIN
- 
+
       IF keyword_set(ndayspm) THEN BEGIN
         IF ndayspm EQ 1 THEN ndayspm = 30
@@ -137 +140 @@
       neg = where(year LT 0)
       IF neg[0] NE -1 THEN year[neg] = year[neg]-1
-    END 
+    END
     'noleap':BEGIN
 
@@ -150 +153 @@
               + (day GT 273) + (day GT 304) + (day GT 334)
       month = long(month)
-; 
+;
       day = day - 31L * (day GT 31) - 28L * (day GT 59) - 31L * (day GT 90) $
               - 30L * (day GT 120) - 31L * (day GT 151) - 30L * (day GT 181) $
@@ -160 +163 @@
         month[zero] = 12L
         day[zero] = 31L
-      ENDIF 
-;
-    END 
+      ENDIF
+;
+    END
     ELSE:BEGIN
       ng = report('only 3 types of calendar are accepted: greg, 360d and noleap')
@@ -180 +183 @@
     second = (TEMPORARY(fraction) - minute/1440d) * 86400d
   ENDIF
-  
+
 ; if julian is an array, reform all output to correct dimensions
   IF (SIZE(julian, /N_DIMENSION) GT 0) THEN BEGIN