Changeset 106 for trunk/SRC/ReadWrite/readbat.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/readbat.pro (modified) (1 diff)

trunk/SRC/ReadWrite/readbat.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME: readbat
+; @file_comments reading the bathymetry ASCII file of OPA
 ;
-; PURPOSE: reading the bathymetry ASCII file of OPA
+; @categories for OPA
 ;
-; CATEGORY: for OPA
+; @param filename {in}{required} a string containing the filename,  
 ;
-; CALLING SEQUENCE: bat=readbat(filename)
-; 
-; INPUTS:
-;    filename: a string containing the filename,  
+; @keyword /ZERO to put 0 on land instead of negatives values for the islands.
 ;
-; KEYWORD PARAMETERS:
-;    /ZERO: to put 0 on land instead of negatives values for the islands.
+; @returns a 2d array
 ;
-; OUTPUTS: a 2d array
-;
-; COMMON BLOCKS:no
-;
-; SIDE EFFECTS:
-;
-; RESTRICTIONS:
-;
-; EXAMPLE:
-;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ;                      May 31, 2002
 ;    based on batlec2.pro, written by Maurice Imbard, March 17, 1998