Changeset 97 for trunk/SRC/Obsolete/vairdate.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/vairdate.pro (modified) (1 diff)

trunk/SRC/Obsolete/vairdate.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME: vairdate
 ;
-;       OBSOLETE: you better use jul2date
+; @file_comments  gives vairmer date equivalent of a date in julian format
+;           sets month, day and year to the corresp values
+; @obsolete
+; @file_comments you better use jul2date
 ;
-; PURPOSE:  gives vairmer date equivalent of a date in julian format
-;           sets month, day and year to the corresp values
+; @examples 
+; IDL> vdate = vairdate(1755087)
 ;
-; CATEGORY:
+; @param jdate {in}{required} date en jours juliens
 ;
-; CALLING SEQUENCE:  vdate = vairdate(1755087)
 ;
-; INPUTS:jdate=date en jours juliens
-;
-; KEYWORD PARAMETERS:
-;
-;    MENSUEL: a activer si on veut pour  que les dates dont le jour est
+; @keyword MENSUEL a activer si on veut pour  que les dates dont le jour est
 ;    15 deviennent avec un jour egale a 0. par ex:
 ;    19990115   ->   19990100
 ;
-;    ANNUEL: a activer si on veut pour  que les dates dont le mois est
+; @keyword  ANNUEL a activer si on veut pour  que les dates dont le mois est
 ;    6 et dont le jour est 1 deviennent avec un mois et jour egale a
 ;    0. par ex:
 ;    19990601   ->   19990000
 ;
-; OUTPUTS:vdate=date vairmer
-;         plus year, month et day
+; @returns vdate date vairmer
+;   plus year, month et day
 ;
-; COMMON BLOCKS:
-;       common.pro
+; @uses  common.pro
 ;
-; SIDE EFFECTS:
 ;
-; RESTRICTIONS:
-;
-; EXAMPLE:
-;
-; MODIFICATION HISTORY: Jerome Vialard  (jv@lodyc.jussieu.fr)
-;                       2/7/98
+; @history  Jerome Vialard  (jv\@lodyc.jussieu.fr)
+;   2/7/98
 ;                13/9/1999, Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;                       ANNUEL,MENSUEL,_EXTRA et possibilite