Changeset 103 for trunk/SRC/Grid/smallmeshmask.pro

Timestamp:

06/12/06 14:12:53 (18 years ago)

Author:

pinsard

Message:

start to modify headers of Grid .pro files for better idldoc output

File:

• trunk/SRC/Grid/smallmeshmask.pro (modified) (2 diffs)

trunk/SRC/Grid/smallmeshmask.pro

@@ -1 +1 @@
 ;+
-; NAME: smallmeshmask.pro
-;
-; PURPOSE: reduce the size of the NetCDF meshmask created by OPA by
-; using byte format for the masks and the foat format for the other
-; fields.
-;
-; CATEGORY:for OPA meshmask files
-;
-; CALLING SEQUENCE: smallmeshmask, ncfilein[, ncfileout]
-;
-; INPUTS: 
-;      ncfilein:
-;      1) the name of the meshmask file to be reduced. In that case,
-;      there is only one meshmask file
-;
-;      OR
-;
-;      2) the xxx part in the names: xxx.mesh_hgr.nc xxx.mesh_zgr.nc
-;      xxx.mask.nc. In that case, the meshmask is split into 3 files.
-;
-;      ncfileout: the name of the reduced meshmask file. default
-;      definition is smallmeshmask.nc
-;
-; KEYWORD PARAMETERS:
-;
-;    IODIR:to define the files path.
-;
-; OUTPUTS: no
-;
-; COMMON BLOCKS: no
-;
-; EXAMPLE:
-;    IDL> meshdir='/d1fes2-raid2/smasson/DATA/ORCA05/'
-;    IDL> smallmeshmask, 'meshmask_ORCA_R05.nc',iodir=meshdir
-;
-; MODIFICATION HISTORY:
-;      July 2004 Sebastien Masson (smasson@lodyc.jussieu.fr)
+;
+;
+; @categories for OPA meshmask files
+;
+; @history
+;      July 2004 Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ;-
 ;------------------------------------------------------
@@ -47 +16 @@
 END
 ;
+;+
+; @file_comments reduce the size of the NetCDF meshmask created by OPA by
+; using byte format for the masks and the foat format for the other
+; fields.
+;
+;    @keyword IODIR to define the files path.
+;      @param ncfilein {in}{required}
+;      1) the name of the meshmask file to be reduced. In that case,
+;      there is only one meshmask file
+;
+;      OR
+;
+;      2) the xxx part in the names: xxx.mesh_hgr.nc xxx.mesh_zgr.nc
+;      xxx.mask.nc. In that case, the meshmask is split into 3 files.
+;
+;      @param ncfileout {in}{optional} the name of the reduced meshmask file. default
+;      definition is smallmeshmask.nc
+;
+; @examples
+;    IDL> meshdir='/d1fes2-raid2/smasson/DATA/ORCA05/'
+;    IDL> smallmeshmask, 'meshmask_ORCA_R05.nc',iodir=meshdir
+;
+; @categories for OPA meshmask files
+;
+; @history
+;      July 2004 Sebastien Masson (smasson\@lodyc.jussieu.fr)
+;-
 PRO smallmeshmask, ncfilein, ncfileout, IODIR = iodir
 ;