Changeset 106 for trunk/SRC/ReadWrite/read_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/read_oasis.pro (modified) (2 diffs)

trunk/SRC/ReadWrite/read_oasis.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:read_oasis
+; @file_comments read the f77 unformated files used in Oasis (version < 2.5) 
 ;
-; PURPOSE:read the f77 unformated files used in Oasis (version < 2.5) 
+; @categories reading
 ;
-; CATEGORY:reading
+;        @param filename {in}{required} the filename
+;        @param varname {in}{required} the name of the variable to be read
+;        @param jpi {in}{required}
+;        @param jpj {in}{required} 
+;        the size of the 2d array to be read
 ;
-; CALLING SEQUENCE: z2d=read_oasis(filename, varname, jpi, jpj)
-; 
-; INPUTS:
-;        filename:the filename
-;        varname: the name of the variable to be read
-;        jpi and jpj the size of the 2d array to be read
+; @keyword /I2 ++ param ou mot clef
+; @keyword /I4
+; @keyword /I8
+; @keyword /R4
+; to change the defaut format (R8) of the data to be read.
 ;
-; KEYWORD PARAMETERS:
-;        /I2, /I4, /I8, /R4: to change the defaut format (R8) of the data to 
-;        be read.
+; @returns a 2d array
 ;
-; OUTPUTS:a 2d array
-;
-; COMMON BLOCKS:
-;
-; SIDE EFFECTS:
-;
-; RESTRICTIONS:
-;
-; EXAMPLE:
+; @examples
 ; IDL> a=read_oasis('grids_orca_t106','a106.lon',320,160)
 ; IDL> m=read_oasis('masks_orca_t106','or1t.msk',182,149,/i4)
@@ -34 +27 @@
 ; see also IDL> scanoasis,'grids_orca_t106'
 ;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ;                      July 01, 2002
 ;-