Changeset 133 for trunk/SRC/Calendar

Timestamp:

07/07/06 11:57:27 (18 years ago)

Author:

navarro

Message:

english and nicer header (1)

Location:

trunk/SRC/Calendar

Files:

• caldat.pro (moved) (moved from trunk/SRC/ToBeReviewed/CALENDRIER/caldat.pro) (2 diffs)
• julday.pro (moved) (moved from trunk/SRC/ToBeReviewed/CALENDRIER/julday.pro) (2 diffs)

trunk/SRC/Calendar/caldat.pro

@@ -1 @@
-; $Id$
+;+
 ;
-; Copyright (c) 1992-2003, Research Systems, Inc.  All rights reserved.
-;       Unauthorized reproduction prohibited.
-;
-
-;+
-; NAME:
-;       CALDAT
-;
-; PURPOSE:
+; @file_comments
 ;       Return the calendar date and time given julian date.
 ;       This is the inverse of the function JULDAY.
-; CATEGORY:
-;       Misc.
+; 
+; @categories Calendar
 ;
-; CALLING SEQUENCE:
-;       CALDAT, Julian, Month, Day, Year, Hour, Minute, Second
-;       See also: julday, the inverse of this function.
 ;
-; INPUTS:
-;       JULIAN contains the Julian Day Number (which begins at noon) of the
+; @param JULIAN {in}{required} contains the Julian Day Number (which begins at noon) of the
 ;       specified calendar date.  It should be a long integer.
-; OUTPUTS:
-;       (Trailing parameters may be omitted if not required.)
-;       MONTH:  Number of the desired month (1 = January, ..., 12 = December).
 ;
-;       DAY:    Number of day of the month.
+; @param MONTH {out} Number of the desired month (1 = January, ..., 12 = December).
 ;
-;       YEAR:   Number of the desired year.
+; @param DAY {out} Number of day of the month.
 ;
-;       HOUR:   Hour of the day
-;       Minute: Minute of the day
-;       Second: Second (and fractions) of the day.
+; @param YEAR {out} Number of the desired year.
 ;
-; KEYWORD PARAMETERS:
+; @param HOUR {out} Hour of the day
 ;
-;       NDAYSPM: for using a calendar with fixed number of days per
-;                months. defaut value of NDAYSPM=30
+; @param Minute {out} Minute of the day
 ;
-; COMMON BLOCKS: cm_4cal
+; @param Second {out} Second (and fractions) of the day.
 ;
-; SIDE EFFECTS:
-;       None.
 ;
-; RESTRICTIONS:
-;       Accuracy using IEEE double precision numbers is approximately
+; @keyword NDAYSPM {default=30} for using a calendar with fixed number of days per
+;                months.
+;
+; @uses cm_4cal
+;
+;
+; @restrictions Accuracy using IEEE double precision numbers is approximately
 ;       1/10000th of a second.
 ;
-; MODIFICATION HISTORY:
-;       Translated from "Numerical Recipies in C", by William H. Press,
+; @history Translated from "Numerical Recipies in C", by William H. Press,
 ;       Brian P. Flannery, Saul A. Teukolsky, and William T. Vetterling.
 ;       Cambridge University Press, 1988 (second printing).
@@ -61 +45 @@
 ;
 ;       AB, 3 January 2000, Make seconds output as DOUBLE in array output.
+;
+; @version $Id$
 ;-
-;
 pro CALDAT, julian, month, day, year, hour, minute, second, NDAYSPM = ndayspm
 ;------------------------------------------------------------

trunk/SRC/Calendar/julday.pro

@@ -1 @@
-; $Id$
-;
-; Copyright (c) 1988-2003, Research Systems, Inc.  All rights reserved.
-;       Unauthorized reproduction prohibited.
-
 ;+
-; NAME:
-;       JULDAY
-;
-; PURPOSE:
-;       Calculate the Julian Day Number for a given month, day, and year.
+;
+; @file_comments
+;       Calculate the Julian Day Number for a given month, day, and year.
 ;       This is the inverse of the library function CALDAT.
 ;       See also caldat, the inverse of this function.
 ;
-; CATEGORY:
-;       Misc.
-;
-; CALLING SEQUENCE:
-;       Result = JULDAY([[[[Month, Day, Year], Hour], Minute], Second])
-;
-; INPUTS:
-;       MONTH:  Number of the desired month (1 = January, ..., 12 = December).
-;
-;       DAY:    Number of day of the month.
-;
-;       YEAR:   Number of the desired year.Year parameters must be valid
+; @categories Calendar
+;
+; @param MONTH {in}{required} Number of the desired month (1 = January, ..., 12 = December). Can be scalar or array
+;
+; @param DAY {in}{required} Number of day of the month.Can be scalar or array
+;
+; @param YEAR {in}{required} Number of the desired year.Year parameters must be valid
 ;               values from the civil calendar.  Years B.C.E. are represented
 ;               as negative integers.  Years in the common era are represented
 ;               as positive integers.  In particular, note that there is no
 ;               year 0 in the civil calendar.  1 B.C.E. (-1) is followed by
-;               1 C.E. (1).
-;
-;       HOUR:   Number of the hour of the day.
-;
-;       MINUTE: Number of the minute of the hour.
-;
-;       SECOND: Number of the second of the minute.
-;
-;   Note: Month, Day, Year, Hour, Minute, and Second can all be arrays.
-;         The Result will have the same dimensions as the smallest array, or
+;               1 C.E. (1). Can be scalar or array
+;
+; @param HOUR {in}{optional} Number of the hour of the day. Can be scalar or array
+;
+; @param MINUTE {in}{optional} Number of the minute of the hour. Can be scalar or array
+;
+; @param SECOND {in}{optional} Number of the second of the minute. Can be scalar or array
+;
+; @restrictions The Result will have the same dimensions as the smallest array, or
 ;         will be a scalar if all arguments are scalars.
-;
-; OPTIONAL INPUT PARAMETERS:
-;       Hour, Minute, Second = optional time of day.
-;
-; KEYWORD PARAMETERS:
-;
-;       NDAYSPM: for using a calendar with fixed number of days per
-;                months. defaut value of NDAYSPM=30
-;
-; OUTPUTS:
-;       JULDAY returns the Julian Day Number (which begins at noon) of the
+; 
+;
+; @keywords NDAYSPM {default=30} for using a calendar with fixed number of days per
+;                months.
+;
+; @ returns JULDAY: the Julian Day Number (which begins at noon) of the
 ;       specified calendar date.  If Hour, Minute, and Second are not specified,
 ;       then the result will be a long integer, otherwise the result is a
 ;       double precision floating point number.
 ;
-; COMMON BLOCKS: cm_4cal
-;
-; SIDE EFFECTS:
-;       None.
-;
-; RESTRICTIONS:
-;       Accuracy using IEEE double precision numbers is approximately
+; @uses cm_4cal
+;
+; @restrictions Accuracy using IEEE double precision numbers is approximately
 ;   1/10000th of a second, with higher accuracy for smaller (earlier)
 ;   Julian dates.
 ;
-; MODIFICATION HISTORY:
-;       Translated from "Numerical Recipies in C", by William H. Press,
+; @history Translated from "Numerical Recipies in C", by William H. Press,
 ;       Brian P. Flannery, Saul A. Teukolsky, and William T. Vetterling.
 ;       Cambridge University Press, 1988 (second printing).
@@ -82 +59 @@
 ;
 ;   CT, April 2000, Now accepts vectors or scalars.
+;
+; @version $Id$
 ;-
 ;