Changeset 231 for trunk/SRC/Grid/ncdf_meshroms.pro

Timestamp:

03/19/07 18:15:51 (17 years ago)

Author:

pinsard

Message:

improvements/corrections of some *.pro headers

File:

• trunk/SRC/Grid/ncdf_meshroms.pro (modified) (3 diffs)

trunk/SRC/Grid/ncdf_meshroms.pro

@@ -1 @@
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
 ;+
 ;
-; @file_comments read NetCDF grid file created by ROMS
+; @file_comments
+; read NetCDF grid file created by ROMS
 ;
 ; @categories
@@ -58 +56 @@
 ;    value will be stored in the common (cm_4mesh) variable key_stride
 ;
-; @keyword _EXTRA used to pass isafile keywords
-;
-; @uses cm_4mesh cm_4data cm_4cal
+; @keyword _EXTRA
+; Used to pass keywords to <pro>isafile</pro>
+;
+; @uses
+; cm_4mesh
+; cm_4data
+; cm_4cal
 ;
 ; @restrictions
-;
-;  ixminmesh,ixmaxmesh,iyminmesh,iymaxmesh,izminmesh,izmaxmesh must
-;  be defined before calling ncdf_meshread. if some of those value
-;  are equal to -1 they will be automatically defined
-;
-;  In the original ROMS grid, if F grid has (jpi,jpj) points then T
-;  grid will have (jpi+1,jpj+1) points, U grid will have (jpi,jpj+1)
-;  points and V grid will have (jpi+1,jpj) points.
-;  By default C-grid used in this package needs the same number of
-;  points for T,U,V and F grid, with a T point at the bottom left
-;  corner of the grid. We therefore ignore the last column of T and
-;  V points and the last line of T and U points.
-;
-;  Scale factors are compuited using the distance between the points
-;  (which is not the exact definition for irregular grid).
+; ixminmesh,ixmaxmesh,iyminmesh,iymaxmesh,izminmesh,izmaxmesh must
+; be defined before calling ncdf_meshread. if some of those value
+; are equal to -1 they will be automatically defined
+;
+; In the original ROMS grid, if F grid has (jpi,jpj) points then T
+; grid will have (jpi+1,jpj+1) points, U grid will have (jpi,jpj+1)
+; points and V grid will have (jpi+1,jpj) points.
+; By default C-grid used in this package needs the same number of
+; points for T,U,V and F grid, with a T point at the bottom left
+; corner of the grid. We therefore ignore the last column of T and
+; V points and the last line of T and U points.
+;
+; Scale factors are compuited using the distance between the points
+; (which is not the exact definition for irregular grid).
 ;
 ; @history
@@ -86 +87 @@
 ;
 ;-
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
+;
 PRO ncdf_meshroms, filename, NRHO = nrho, GLAMBOUNDARY = glamboundary $
                   , ONEARTH = onearth, GETDIMENSIONS = getdimensions $
                   , PERIODIC = periodic, SHIFT = shift, STRIDE = stride $
                   , STRCALLING = strcalling, _EXTRA = ex
-;
-;---------------------------------------------------------
 ;
   compile_opt idl2, strictarrsubs