Changeset 231 for trunk/SRC/Obsolete/lec.pro

Timestamp:

03/19/07 18:15:51 (17 years ago)

Author:

pinsard

Message:

improvements/corrections of some *.pro headers

File:

• trunk/SRC/Obsolete/lec.pro (modified) (5 diffs)

trunk/SRC/Obsolete/lec.pro

@@ -1 @@
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
 ;+
 ; @file_comments
@@ -21 +18 @@
 ; IDL> resultat=lec('nom_Vairmer'[,date[,'nom_experience']])
 ;
-; @param nomchamp {in}{required} 2 choix possibles:
+; @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
@@ -29 +27 @@
 ; plus rapide car elle va directement chercher le fichier qui nous interesse.
 ;
-; @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
+; @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','')
 ;
-; @keyword ECRIT {in} 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.
@@ -43 +45 @@
 ; @keyword BOITE
 ;
-; @keyword EXPANOM {in} si on calcule l'anom par rapport a une exper
-;       differente
-;
-; @keyword FILENAME string pour passer directement le nom du champ sans
+; @keyword EXPANOM {in}
+; si on calcule l'anom par rapport a une exper differente
+;
+; @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.
 ;
-; @keyword 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'.
 ;
-; @keyword 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'.
 ;
-; @keyword 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)
 ;
-; @returns 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
 ; cession en cours (jpi,jpj,jpk).
 ; pour les sous domaines cf:
-;        http://www.ipsl.jussieu.fr/~smlod/sousdomaine.html
+;        <a href="http://www.ipsl.jussieu.fr/~smlod/sousdomaine.html">
 ; Retourne -1 en cas d'erreur.
 ;
-; @uses common.pro isnumber.pro fivardate.pro
+; @uses
+; common.pro
+; isnumber.pro
+; fivardate.pro
 ;
 ; @history
@@ -83 +93 @@
 ;                       2/99
 ;
-; @version 
+; @version
 ; $Id$
-;
-;;-
-;--------------------------------------------------------------
-;--------------------------------------------------------------
-;--------------------------------------------------------------
+;-
+;
 function lec, nomchamp,date,nomexp,ECRIT=ecrit,ANOM=anom, BOITE = boite,EXPANOM=expanom, TOUT = tout, GRID = grid, NAME = name, filename = FILENAME
 ;