Changeset 97 for trunk/SRC/Obsolete/lect.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/lect.pro (modified) (2 diffs)

trunk/SRC/Obsolete/lect.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:lect
 ;   
-; PURPOSE:
+; @file_comments
 ;       lit les fichiers Vairmer de date1 a date2 et en sort un tableau
 ;       1D, 2D ou 3D qui peut etre reutilise pour une courbe / hov / animation
-;       cette fonction modifie aussi les variables globales:
-;               varname: huit lettres: nom Vairmer du champ a tracer
-;               vargrid:1 lettre : nom de la grille
-;               varexp: trois lettres :nom de l'experience
-;
-; CATEGORY:
-;       Graphics, lecture de fichier Vaimer
-;
-; CALLING SEQUENCE:
-;       resultat=lec('nom_Vairmer',date1,date2,'nomexp','direc',BOITE=boite)
-;
-; INPUTS:
-;       nom_Vairmer: nom de champ Vairmer (chaine de 8 caracteres commencant
+;cette fonction modifie aussi les variables globales:
+;varname: huit lettres: nom Vairmer du champ a tracer
+;vargrid:1 lettre : nom de la grille
+;varexp: trois lettres :nom de l'experience
+;
+; @obsolete
+;
+; @categories Graphics, lecture de fichier Vaimer
+;
+; @examples
+; IDL> resultat=lec('nom_Vairmer',date1,date2,'nomexp','direc',BOITE=boite)
+;
+; @param nomchamp {in}{required} nom de champ Vairmer (chaine de 8 caracteres commencant
 ;                    par VO ou SO
-;       date de depart (date1) et de fin (date2) de la serie temporelle a
+;         @param date1 {in}{required} date de depart de la serie temporelle a
+;         @param date2 {in}{required} date de fin (date2) de la serie temporelle a
 ;             extraire
-;       nomexp nom de l' experience a lire (prefix pardefaut)
-;
-;       direc : 'x' 'y' 'z' 'xy' 'xz' 'yz' 'xyz' 'xt' 'yt' 'zt' 'xyt' 'xzt'
+;       @param nomexp {in}{required} nom de l' experience a lire (prefix pardefaut)
+;
+;       @param direc  {in}{required} 'x' 'y' 'z' 'xy' 'xz' 'yz' 'xyz' 'xt' 'yt' 'zt' 'xyt' 'xzt'
 ;       'yzt' 'xyzt' directions selon lesquelles effectuer les moyennes
 ;       (si rien n'est donne on n'effectue pas de moyenne)
@@ -32 +32 @@
 ;
 ;
-; KEYWORD PARAMETERS:
-;         boite  : boite sur laquelle integrer (par defaut tt le domaine)
-;         anom   : type de fichiers ('SE','AN','') a relire pour calc une
+;       @keyword boite {in} boite sur laquelle integrer (par defaut tt le domaine)
+;       @keyword  anom {in} type de fichiers ('SE','AN','') a relire pour calc une
 ; anomalie  
-;         expanom: experience pour laquelle on veut calculer une anomalie
+;         @keyword expanom {in} experience pour laquelle on veut calculer une anomalie
 ; (par defaut la meme que nomexp)
-;         repeat : nombre de fois que l'on veut dupliquer la serie bout a bout
-;
-; COMMON BLOCKS:
-;       common          vraidate        juldate
-;
-; SIDE EFFECTS:
-;
-; RESTRICTIONS:
-;
-; EXAMPLE:
-;
-; MODIFICATION HISTORY: Jerome Vialard (jv@lodyc.jussieu.fr)
-;                       2/7/98
+;
+; @uses common vraidate juldate
+;
+; @history Jerome Vialard (jv\@lodyc.jussieu.fr)
+; 2/7/98
 ;-
 ;--------------------------------------------------------------