Changeset 106 for trunk/SRC/ReadWrite/write_oasis.pro

Timestamp:

06/12/06 16:49:30 (18 years ago)

Author:

pinsard

Message:

start to modify headers of ReadWrite? *.pro files for better idldoc output

File:

• trunk/SRC/ReadWrite/write_oasis.pro (modified) (1 diff)

trunk/SRC/ReadWrite/write_oasis.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:write_oasis
 ;
-; PURPOSE:write an Oasis file (version < 2.5)
+; @file_comments write an Oasis file (version < 2.5)
 ;
-; CATEGORY:
+; @param filename {in}{required} the filename
+; @param varname {in}{required} the name of the variable to be written
+; @param z2d {in}{required} the variable (2D array) to be written
 ;
-; CALLING SEQUENCE:write_oasis, filename, varname, z2d
-; 
-; INPUTS:
-;        filename:the filename
-;        varname: the name of the variable to be written
-;        z2d: the variable (2D array) to be written
+; @keyword /I2 ++ param ou mot clef
+; @keyword /I4
+; @keyword /I8
+; @keyword /R4
+; to change the defaut format (R8) of the data to be written.
 ;
-; KEYWORD PARAMETERS:
-;        /I2, /I4, /I8, /R4: to change the defaut format (R8) of the data to 
-;        be written.
-;
-;        /APPEND: to open the file with the file pointer at the end of
+; @keyword /APPEND to open the file with the file pointer at the end of
 ;        the file, ready for data to be appended.
 ;
-; OUTPUTS:
 ;
-; COMMON BLOCKS:
-;
-; SIDE EFFECTS:varname is automatically written as a "charactere*8"
+; @restrictions varname is automatically written as a "charactere*8"
 ;              by defaut z2d is written as an R8 array
 ;
-; RESTRICTIONS:
-;
-; EXAMPLE:
-;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ;                      July 01, 2002
 ;-