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

trunk/SRC/ReadWrite/writebat.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME: writebat
 ;
-; PURPOSE: write the bathymetry ASCII file of OPA
+; @file_comments write the bathymetry ASCII file of OPA
 ;
-; CATEGORY: for OPA
+; @categories for OPA
 ;
-; CALLING SEQUENCE: writebat, bat, filename,
-; 
-; INPUTS:
-;    bat: the bathymetry, a 2d array  
-;    filename: a string containing the filename,  
+; @param zbat {in}{required} the bathymetry, a 2d array  
+; @param filename {in}{required} a string containing the filename,  
 ;
-; KEYWORD PARAMETERS:
-;
-; OUTPUTS:no
-;
-; COMMON BLOCKS:no
-;
-; SIDE EFFECTS:
-;
-; RESTRICTIONS:
-;
-; EXAMPLE:
-;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ;                      Sept 30, 2003
 ;    based on batsav2.pro, written by Maurice Imbard, March 17, 1998