Changeset 136 for trunk/SRC/Interpolation/get_gridparams.pro

Timestamp:

07/10/06 17:20:19 (18 years ago)

Author:

pinsard

Message:

some improvements and corrections in some .pro file according to
aspell and idldoc log file

File:

• trunk/SRC/Interpolation/get_gridparams.pro (modified) (2 diffs)

trunk/SRC/Interpolation/get_gridparams.pro

@@ -2 +2 @@
 ;
 ; @file_comments
-;   1) extract from a NetCDF file the longitude, latidude, and their dimensions
-;      and make sure it is 1D or 2D arrays
-;
-;   or
-;   2) given longitude and latitude arrays get their dimensions and make
-;  sure they are 1D or 2D arrays
+; 1) extract from a NetCDF file the longitude, latidude, and their dimensions
+; and make sure it is 1D or 2D arrays
+;
+; or
+; 2) given longitude and latitude arrays get their dimensions and make
+; sure they are 1D or 2D arrays
 ;
 ; @categories interpolation
@@ -22 +22 @@
 ;
 ; 1)
-; @param in1 {in}{required} the name of the netcdf file
-; @param in2 {in}{required} the name of the variable that contains the longitude in the NetCDF file
-; @param in3 {in}{required} the name of the variable that contains the latitude in the NetCDF file
-; @param in4 {out} the number of points in the longitudinal direction
-; @param in5 {out} the number of points in the latitudinal direction
-; @param in6 {out} the variable that will contain the longitudes
-; @param in7 {out} the variable that will contain the latitudes
-; @param in8 {out} 1 or 2 to specify if lon and lat should be 1D (jpi or jpj)
+; @param in1 {in}{required}
+; the name of the netcdf file
+;
+; @param in2 {in}{required}
+; the name of the variable that contains the longitude in the NetCDF file
+;
+; @param in3 {in}{required}
+; the name of the variable that contains the latitude in the NetCDF file
+;
+; @param in4 {out}
+; the number of points in the longitudinal direction
+;
+; @param in5 {out}
+; the number of points in the latitudinal direction
+;
+; @param in6 {out}
+; the variable that will contain the longitudes
+;
+; @param in7 {out}
+; the variable that will contain the latitudes
+;
+; @param in8 {out}
+; 1 or 2 to specify if lon and lat should be 1D (jpi or jpj)
 ;
 ; or
 ;
 ; 2)
-; @param in1 {in}{required} 1d or 2D arrays defining longitudes and latitudes.
-; @param in2 {in}{required} 1d or 2D arrays defining longitudes and latitudes.
-;    Note that these arrays are also outputs and can therefore be modified.
-
-; @param in1 {out} the variable that will contain the longitudes
-; @param in2 {out} the variable that will contain the latitudes
-; @param in3 {in} the number of points in the longitudinal direction
-; @param in4 {in} the number of points in the latitudinal direction
-; @param in5 {in} 1 or 2 to specify if lon and lat should be 1D (jpi or jpj)
-;    arrays or 2D arrays (jpi,jpj). Note that of  n_dimensions = 1, then the
-;    grid must be regular (each longitudes must be the same for all latitudes
-;    and each latitudes should be the sae for all longitudes).
-;
-; @keyword DOUBLE use double precision to perform the computation
+; @param in1 {in}{required}
+; 1d or 2D arrays defining longitudes and latitudes.
+;
+; @param in2 {in}{required}
+; 1d or 2D arrays defining longitudes and latitudes.
+; Note that these arrays are also outputs and can therefore be modified.
+;
+; @param in1 {out}
+; the variable that will contain the longitudes
+;
+; @param in2 {out}
+; the variable that will contain the latitudes
+;
+; @param in3 {in}
+; the number of points in the longitudinal direction
+;
+; @param in4 {in}
+; the number of points in the latitudinal direction
+;
+; @param in5 {in}
+; 1 or 2 to specify if lon and lat should be 1D (jpi or jpj)
+; arrays or 2D arrays (jpi,jpj). Note that of  n_dimensions = 1, then the
+; grid must be regular (each longitudes must be the same for all latitudes
+; and each latitudes should be the sae for all longitudes).
+;
+; @keyword DOUBLE
+; use double precision to perform the computation
 ;
 ; @examples