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

trunk/SRC/ReadWrite/readoldoparestart.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:readoldoparestart
-;      based on the OPA subroutine dtrlec included at the end of the
-;      file.
-;
-; PURPOSE:read the old restart files of OPA (before NetCDF)
-;
-; CATEGORY:for OPA before NetCDF
-;
-; CALLING SEQUENCE:readoldoparestart, filename, jpiglo, jpjglo, jpk
-; 
-; 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
-;     UB, VB, TB, SB, ROTB, HDIVB, UN, VN, TN, SN, ROTN, HDIVN, GCX,
-;     GCXB, ETAB, TAN, BSFB, BSFN, BSFD, EN: the variable we want to
-;     read. 
-;
-; OUTPUTS:according to the given keywords.
-;
-; COMMON BLOCKS:none
-;
-; SIDE EFFECTS:
-;
-; RESTRICTIONS:bug for etab and etan written on the same record???
-;
-; EXAMPLE:
-;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
+;
+; @categories for OPA before NetCDF
+;
+; @restrictions bug for etab and etan written on the same record???
+;
+; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ;                      June 2002
 ;-
@@ -48 +21 @@
    return, a[0]
 end
+;+
+; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)
+;                      June 2002
+;-
 FUNCTION read3fromopa, unit, params, num
    offset=params.reclen*params.jpk*(num-1L)
@@ -54 +31 @@
 end
 
+;+
+; @file_comments read the old restart files of OPA (before NetCDF)
+;      based on the OPA subroutine dtrlec included at the end of the
+;      file.
+; @categories for OPA before NetCDF
+;     @param filename {in}{required} 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, defalut: jpbyt = 8L
+;     @keyword NUMREC number of records in the file. defalut: numrec = 19L*jpk
+;     @keyword UB
+;     @keyword VB
+;     @keyword TB
+;     @keyword SB
+;     @keyword ROTB
+;     @keyword HDIVB
+;     @keyword UN
+;     @keyword VN
+;     @keyword TN
+;     @keyword SN
+;     @keyword ROTN
+;     @keyword HDIVN
+;     @keyword GCX
+;     @keyword GCXB
+;     @keyword ETAB
+;     @keyword ETAN
+;     @keyword BSFB
+;     @keyword BSFN
+;     @keyword BSFD
+;     @keyword EN
+;       the variable we want to read. 
+;
+; @returns according to the given keywords.
+; @restrictions bug for etab and etan written on the same record???
+;
+; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)
+;                      June 2002
+;-
 
 PRO readoldoparestart, filename, jpiglo, jpjglo, jpk, IBLOC = ibloc, JPBYT = jpbyt, NUMREC = numrec, ub = ub, vb = vb, tb = tb, sb = sb, rotb = rotb, hdivb = hdivb, un = un, vn = vn, tn = tn, sn = sn, rotn = rotn, hdivn = hdivn, gcx = gcx, gcxb = gcxb, etab = etab, etan = etan, bsfb = bsfb, bsfn = bsfn, bsfd = bsfd, en = en