Changeset 97 for trunk/SRC/Obsolete/juldate.pro

Timestamp:

06/09/06 17:18:59 (18 years ago)

Author:

pinsard

Message:

start to modify headers of Obsolete *.pro files for better idldoc output

File:

• trunk/SRC/Obsolete/juldate.pro (modified) (3 diffs)

trunk/SRC/Obsolete/juldate.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME: juldate
+; @file_comments you better use date2jul
+; @obsolete
 ;
-;       OBSOLETE: you better use date2jul
-;
-; PURPOSE:  gives julian date equivalent of a date in vairmer 
+; @file_comments  gives julian date equivalent of a date in vairmer 
 ;           ( yymmdd or yyyymmdd ) format 
 ;           sets month, day and year to the corresp values
 ;
-; CATEGORY: bidouilles dates
+; @categories calendar
 ;
-; CALLING SEQUENCE:  date = juldate(930124)
+; @param vvdate {in} date de la forme yymmdd ou yyyymmdd
 ;
-; INPUTS:date de la forme yymmdd ou yyyymmdd
+; @uses common.pro vraidate
 ;
-; KEYWORD PARAMETERS:
-;
-;       /VRAIDATE: pour ne pas transformer l''annnee 01 en 1901 
-;       /GRADS: if  1 le year le 49 then year = 2000+year
-;               if 50 le year le 99 then year = 1900+year
-;
-; OUTPUTS:date en jour julien
-;
-; COMONTHON BLOCKS:
-;       common.pro      vraidate
-;
-; SIDE EFFECTS:
+; @returns date en jour julien
 ;   l'annee 0 n'existant pas, qd year est nulle on calcule le
 ;     jour julien de l'annee -1.
@@ -35 +23 @@
 ;   Attention, les variables globales year, month day sont attribuees
 ;
-; MODIFICATION HISTORY: Jerome Vialard  (jv@lodyc.jussieu.fr)
-;                       2/7/98
+; @examples 
+; IDL> date = juldate(930124)
+;
+; @history Jerome Vialard  (jv\@lodyc.jussieu.fr)
+; 2/7/98
 ;-
 ;------------------------------------------------------------
@@ -63 +54 @@
 end
 ;------------------------------------------------------------
-