Changeset 161 for trunk/tools/idl_netcdf/ncdf_colle.pro

Timestamp:

11/12/09 17:15:09 (15 years ago)

Author:

pinsard

Message:

conversion from IDL help header syntax to IDLDOC 2. header syntax

File:

• trunk/tools/idl_netcdf/ncdf_colle.pro (modified) (2 diffs)

trunk/tools/idl_netcdf/ncdf_colle.pro

@@ -1 @@
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
 ;+
-; NAME:ncdf_colle
-;
-; PURPOSE:permet de coller n fichiers entre eux suivant une
+;
+; permet de coller n fichiers entre eux suivant une
 ; direction. c.a.d. qu''un nouveau fichier de sortie est ecrit et que
 ; si les variables comportent la dimension a coller alors la variable
 ; de sortie sera un collage des n variables d''entree suivant la dite dimension
 ;
-; CATEGORY:bidouille de fichiers netcdf
-;
-; CALLING SEQUENCE:ncdf_colle,'nomfich1,nomfich2,nomfich3,...','nomfichout','nomdirection'
-;
-; INPUTS:
-;        'nomfich1,nomfich2,nomfich3,...': un string contenant la
+; @categories
+; bidouille de fichiers netcdf
+;
+; @param LISTIN {in}{required} 
+; 'nomfich1,nomfich2,nomfich3,...': un string contenant la
 ;        liste des noms des ficchiers en entree separes par une virgule
 ;
-;        'nomfichout': un string contenant le nom du fichier en sortie
-;
-;        'nomdirection': un string contenant le nom de la dimension
-;        suivant laquelle on doit faire le collage.     
-;
-; REMARQUE: si nomdimection n''existe pas ds le fichier et que les
+; @param NOMFICHOUT {in}{required}
+; un string contenant le nom du fichier en sortie
+;
+; @param NOMDIREC {in}{required}
+; un string contenant le nom de la dimension
+; suivant laquelle on doit faire le collage.     
+;
+; REMARQUE: si nomdirec n''existe pas ds le fichier et que les
 ; fichiers d''entree ne comportent pas de dimension infinie alors on cree la dimension
-;  infinie nomdirection et on constitue pour chaque variable un
+;  infinie nomdirec et on constitue pour chaque variable un
 ;  "empilement" des n tableaux suivant la nouvelle direction. En clair
 ;  avec n fichiers sans dim temporelle on cree une serie temporelle de n pas de temps.
 ;
-; KEYWORD PARAMETERS:
-;        
-;        GARDE: vecteur donnant les noms des variables a
+; @keyword GARDE
+; vecteur donnant les noms des variables a
 ;        selectionner. si il n'est pas active toutes les variables
 ;        sont selectionnees.
 ;
-;        EXCLU: vecteur donnant les noms des variablers a ne pas
+; @keyword EXCLU
+; vecteur donnant les noms des variablers a ne pas
 ;        selectionner. si il n'est pas active toutes les variables
 ;        sont selectionnees.
 ;
-; OUTPUTS:
-;
-; COMMON BLOCKS: attention cette procedure fait appelle a la fonction
+; @uses 
+; attention cette procedure fait appelle a la fonction
 ; colle.pro
 ;  souvant pour une raison encore inexpliquee, IDL ne reconnait pas ds
@@ -63 +59 @@
 ; plantages en serie IDL affiche unable to allocate memory... 
 ;
-; RESTRICTIONS:
-;
-; EXAMPLE:
-;
-; MODIFICATION HISTORY: Sebastien Masson (smasson\@lodyc.jussieu.fr)
+; @restrictions
+;
+; @examples 
+;
+; @history 
+; Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ;                       23/11/98
 ; 13/1/98 : attribut concernant le min et le max
 ;-
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
 PRO ncdf_colle, listin, nomfichout, nomdirec, GARDE = garde,  EXCLU = exclu
    nomdirec = strlowcase(nomdirec)