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

trunk/SRC/Obsolete/nlecsaison.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:NLECAN
+; @file_comments lit les moyennes annuelles
+; sur maia: /u/rech/eee/reee217/TOTEM/REF/OUTPUTS 
+; @obsolete
 ;
-; PURPOSE:lit les moyennes annuelles
-; sur maia: /u/rech/eee/reee217/TOTEM/REF/OUTPUTS 
+; @categories lecture de NETCDF
 ;
-; CATEGORY:lecture de NETCDF
+; @examples
+; IDL> res=nlecsaison(nom, numsortie79, nbretps)
 ;
-; CALLING SEQUENCE:res=nlecsaison(nom, numsortie79, nbretps)
+; @param nom {in}{required} nom du tableau contenant le champ que l'on veut (le
+; trouver avec ncdflec,fichier,/var
+; @param numsortie79  {in}{required} le numero du pas de temps que l'on veut sortir du
+; fichier (compte a partir de 1) a partir de 79
+;  @param nbretps  {in}{required} nombre de pas de temps a extraire
 ;
-; INPUTS:
-;       nom:nom du tableau contenant le champ que l'on veut (le
-; trouver avec ncdflec,fichier,/var
-;       numsortie79:le numero du pas de temps que l'on veut sortir du
-; fichier (compte a partir de 1) a partir de 79
-;       nbretps:nombre de pas de temps a extraire
+; @keyword      BOITE boite sur laquelle integrer (par defaut tt le domaine)
 ;
-; KEYWORD PARAMETERS:
-;
-;       BOITE: boite sur laquelle integrer (par defaut tt le domaine)
-;
-;       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
+; @keyword /TOUT oblige a lire le tableau entier en non pas celui reduit a domdef
 ;
-; OUTPUTS: res=tableau 2d (qd la serie ne fait que 1 pas de temps) ou
+; @returns tableau 2d (qd la serie ne fait que 1 pas de temps) ou
 ; 3d (valable ds 1 premier tps que pour les tableaux 2d)
 ; 
-; COMMON BLOCKS:
-;       common.pro
+; @uses common.pro
 ;
-; SIDE EFFECTS:appele par nlec
+; @restrictions appele par nlec
 ;
-; RESTRICTIONS:
-;
-; EXAMPLE:
-;
-; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ;
 ;-