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

trunk/SRC/Obsolete/meshlec.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:meshlec
-;
-; PURPOSE: lecture du mask de des sorties d'OPA. les sources se trouvent ds les 
+;
+; @file_comments lecture du mask de des sorties d'OPA. les sources se trouvent ds les 
 ; repertoires sur maia du type:
 ;  /nom_exp/RESTARTS
 ;
-; CATEGORY:
-;
-; CALLING SEQUENCE:meshmask[,' nomfich']
-;
-; INPUTS:
-;    nomfich: string, c''est le nom du fichier a lire. Par defaut, c''est
-;             meshmask. 
-;
-; KEYWORD PARAMETERS:
-;
-;    GLAMBOUNDARY: un vecteur de 2 elements specifaint le min et le
+; @obsolete
+; @examples
+; IDL> meshmask[,' nomfich']
+;
+; @param  nomfich {in}{required} string, c''est le nom du fichier a lire. Par defaut, c''est meshmask. 
+;
+;
+;  @keyword GLAMBOUNDARY {in} un vecteur de 2 elements specifaint le min et le
 ;    max qui doivent etre imposes en longitude (obligatoire si le
 ;    tableau depasse 360 degres)
 ;
-;        /pasblabla: pour suprimer les blablas
-;
-;        /DOUBLE: pour forcer a lire les tableaux en double
+; @keyword /pasblabla {in} pour suprimer les blablas
+;
+; @keyword /DOUBLE {in} pour forcer a lire les tableaux en double
 ;        precision. ce Mot clef est maintenant active
 ;        automatiquement.
 ;
-; OUTPUTS:
-;
-; COMMON BLOCKS:
-;       common.pro
-;
-; SIDE EFFECTS:
-;
-; RESTRICTIONS:
-;
+; @uses common.pro
+;
+; @restrictions
 ;  La definition de ixminmesh,ixmaxmesh,iyminmesh,iymaxmesh
 ;  ,izminmesh,izmaxmesh doit etre faite avant l''entree dans cette
@@ -43 +33 @@
 ;  possible les mettre toutes a -1 et meshlec les calculera.
 ;
-; EXAMPLE:
-;
-; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ;     Marina Levy : lecture en double precision (cas calcul sur shine)
 ;-
@@ -65 +53 @@
 ;  a 1: cf le fichier wrivr2.F ds WKOPA sur le cray
 ;----------------------------------------------------------
-;       LECTURE DU MASK trouve ds les fichiers restart
+; LECTURE DU MASK trouve ds les fichiers restart
 ;----------------------------------------------------------
 ;----------------------------------------------------------