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

trunk/SRC/Obsolete/nlec.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:nlec
-;
-; PURPOSE:lit les fichiers Net-Cdf de l'experience TOTEM/ECMWF qui sont sur
+; @file_comments lit les fichiers Net-Cdf de l'experience TOTEM/ECMWF qui sont sur
 ; maia: /u/rech/eee/reee217/TOTEM/REF/OUTPUTS
-;
-; CATEGORY:
-;
-; CALLING SEQUENCE:
-;
-; INPUTS:nom:nom du tableau contenant le champ que l'on veut (le
+; @obsolete
+;
+; @param name {in}{required} nom du tableau contenant le champ que l'on veut (le
 ; trouver avec ncdflec,fichier,/var
 ;
-;       arguments optionnels:
-;       
-;       date:nombres de 6 ou 8 chiffres (anneemoisjour, par ex:19980507)
-;       nom_experience:trois lettres designant le nom de l'experience
-;
-;
-; KEYWORD PARAMETERS:
-;
-;       BOITE: boite sur laquelle integrer (par defaut tt le domaine)
-;
-;       DATE2:stipule la seconde date pour extraire une serie temporelle
-;
-;       DIREC: 'x' 'y' 'z' 'xy' 'xz' 'yz' 'xyz' directions selon lesquelles
+; @param debut {in} nombres de 6 ou 8 chiffres (anneemoisjour, par ex:19980507)
+; @param fin {in} nombres de 6 ou 8 chiffres (anneemoisjour, par ex:19980507)
+; @param nomexperience {in}{optional} trois lettres designant le nom de l'experience
+;
+;
+;       @keyword BOITE boite sur laquelle integrer (par defaut tt le domaine)
+;
+;       @keyword DIREC: 'x' 'y' 'z' 'xy' 'xz' 'yz' 'xyz' directions selon lesquelles
 ;             effectuer les moyennes (si rien n'est donne on n'effectue pas de moyenne)
 ;
-;       GRILLE:impose la grille a laquelle est rapporte le champ. rq permet
+; @keyword GRILLE impose la grille a laquelle est rapporte le champ. rq permet
 ; d'aller plus vite ds la lecture 
 ;
-;       /TOUT:oblige a lire le tableau entier en non pas celui reduit a domdef
-;
-; OUTPUTS:
-;
-; COMMON BLOCKS:
-;       common.pro      vraidate        juldate 
-;       nlec5j          nlecserie
-;
-; SIDE EFFECTS:
-;
-; RESTRICTIONS:
-;
-; EXAMPLE:
-;
-; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
-;                       14/8/98
+; @keyword /TOUT oblige a lire le tableau entier en non pas celui reduit a domdef
+;
+; @uses common.pro vraidate juldate  nlec5j          nlecserie
+;
+; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)
+;   14/8/98
 ;-
 ;------------------------------------------------------------