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

trunk/SRC/ReadWrite/readoldopadistcoast.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:readoldopadistcoast
-;
-; PURPOSE:
+; @file_comments
 ;      read the old binary direct access file that contains the
 ;      distance to the coast in OPA.
 ;      based on the OPA subroutines dtacof and parctl
 ;
-; CATEGORY:for OPA before NetCDF
+; @categories for OPA before NetCDF
 ;
-; CALLING SEQUENCE:res=readoldopadistcoast(filename)
 ;
-; INPUTS:
-;      filename (with the whole path if necessary)
-;     jpiglo, jpjglo, jpk: dimensions of the opa grid
-;
-; KEYWORD PARAMETERS:
-;     IBLOC: ibloc size, default: ibloc = 4096L
-;     JPBYT: jpbyt size, defalut: jpbyt = 8L
-;     NUMREC: number of records in the file. defalut: numrec = 19L*jpk
-;
-; OUTPUTS: a structure that contains two elements: tdistcoast (the
+; @returns  a structure that contains two elements: tdistcoast (the
 ; distance for the t-points) and fdiscoast (the distance for the
 ; f-points).
 ;
-; COMMON BLOCKS: no
-;
-; SIDE EFFECTS:
-;
-; RESTRICTIONS:
-;
-; EXAMPLE:
-;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ;                      June, 2002
 ;-
@@ -49 +29 @@
 end
 
-
+;+
+;     @param filename {in}{required} filename (with the whole path if necessary)
+;     @param jpiglo {in}{required}
+;     @param jpjglo {in}{required}
+;     @param jpk {in}{required}
+;      dimensions of the opa grid
+;     @keyword IBLOC ibloc size, default: ibloc = 4096L
+;     @keyword JPBYT jpbyt size, default: jpbyt = 8L
+;     @keyword NUMREC number of records in the file. default: numrec = 19L*jpk
+; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)
+;                      June, 2002
+;-
 FUNCTION readoldopadistcoast, filename, jpiglo, jpjglo, jpk, IBLOC = ibloc, JPBYT = jpbyt, NUMREC = numrec
 ;