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

trunk/SRC/Obsolete/lec.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:lec
-;   
-;
-; PURPOSE:
+; @file_comments
 ;       lit les fichiers Vairmer en sort:
-;               un tableau 2d ou 3d en fonction de nomchamp qui est le nom
-; du champ a extaire (2d s'il commence par SO et 3d s'il commence par VO)
-;       cette fonction modifie aussi les variables globales:
-;               varname: trois lettres: nom de l'experience
-;               vargrid: nom de la grille
-;               vardate: date (yy)yymmdd
-;               varexp: nom Vairmer du champ a tarcer
-;
-; CATEGORY:
-;       Graphics, lecture de fichier Vaimer
-;
-; CALLING SEQUENCE:
-;       resultat=lec('nom_Vairmer'[,date[,'nom_experience']])
-;
-; INPUTS:
-;       nom_Vairmer: 2 choix possibles:
+;un tableau 2d ou 3d en fonction de nomchamp qui est le nom
+;du champ a extaire (2d s'il commence par SO et 3d s'il commence par VO)
+;cette fonction modifie aussi les variables globales:
+;varname: trois lettres: nom de l'experience
+;vargrid: nom de la grille
+;vardate: date (yy)yymmdd
+;varexp: nom Vairmer du champ a tarcer
+;
+; @obsolete
+; @categories Graphics, lecture de fichier Vaimer
+;
+; @examples
+; IDL>resultat=lec('nom_Vairmer'[,date[,'nom_experience']])
+;
+; @param nomchamp {in}{required} 2 choix possibles:
 ;             1) nom de champ Vairmer (chaine de 8 caracteres en majuscule ou 
 ; minuscule commencant par vo ou so). Dans cette methode on saute directement
@@ -31 +27 @@
 ; plus rapide car elle va directement chercher le fichier qui nous interesse.
 ;
-;       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:
-;
-;       /ANOM:type du fichier vairmer par rapport auquel on doit calculer 
+; @param date {in}{optional} nombres de 6 ou 8 chiffres (anneemoisjour, par ex:19980507)
+; @param nomexp {in}{optional} trois lettres designant le nom de l'experience
+;
+;
+; @keyword /ANOM {in} type du fichier vairmer par rapport auquel on doit calculer 
 ;             l'anomalie ('EX','AN','SE','MO','')
 ;
-;       /ECRIT:permet d'imprimer tous les noms vairmer que contient le fichier.
+; @keyword /ECRIT {in} permet d'imprimer tous les noms vairmer que contient le fichier.
 ; ds ce cas en input on met seulement 'vo' ou 'so' la fonction retourne le
 ; nombre de fichiers lus.
 ;
-;       /EXPANOM: si on calcule l'anom par rapport a une exper
+; @keyword /EXPANOM {in} si on calcule l'anom par rapport a une exper
 ;       differente
 ;
-;       FILENAME: string pour passer directement le nom du champ sans
+; @keyword FILENAME string pour passer directement le nom du champ sans
 ;       utiliser les inputs: nom_Vairmer',date,'nom_experience'. Rq si
 ;       ces inputs sont qd meme donnes ils ne sont pas modifies par
 ;       filename.
 ;
-;       /GRID:lorsque ce mot clef est active, lec retourne la liste
+; @keyword /GRID lorsque ce mot clef est active, lec retourne la liste
 ;       des types de grilles (T, U...) auxquelles se rapportent les
 ;       variables. ds ce cas en input on met seulement 'vo' ou 'so'.
 ;
-;       /NAME:lorsque ce mot clef est active, lec retourne la liste
+; @keyword /NAME lorsque ce mot clef est active, lec retourne la liste
 ;       des noms des variables. ds ce cas en input on met seulement
 ;       'vo' ou 'so'.
 ;
-;       /TOUT: oblige lec a lire le champ sur tout le domaine qui a
+; @keyword /TOUT  oblige lec a lire le champ sur tout le domaine qui a
 ;       etait selectionne pour la cession en cours (jpi,jpj,jpk)
 ;
-; OUTPUTS: un tableau 2 ou 3d. sans le mot cle /TOUT, sa taille est
+; @returns un tableau 2 ou 3d. sans le mot cle /TOUT, sa taille est
 ; celle du sous domaine definit par domdef (nx,ny,nz). avec /TOUT le
 ; champ a la taille du  domaine qui a etait selectionne pour la
@@ -70 +63 @@
 ; pour les sous domaines cf:  
 ;        http://www.ipsl.jussieu.fr/~smlod/sousdomaine.html
-;
-; COMMON BLOCKS:
-;       common.pro         isnumber.pro         fivardate.pro  
-;
-; SIDE EFFECTS:Retourne -1 en cas d'erreur.
-;
-; RESTRICTIONS:
-;
-; EXAMPLE:
-;
-; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
+; Retourne -1 en cas d'erreur.
+;
+; @uses common.pro isnumber.pro fivardate.pro  
+;
+; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ;                       26/5/98
 ;                       Jerome Vialard : adaptation au format vairmer