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

Timestamp:

06/12/06 10:29:56 (18 years ago)

Author:

pinsard

Message:

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

File:

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

trunk/SRC/Interpolation/get_gridparams.pro

@@ -1 +1 @@
 ;+
-; NAME: get_gridparams
-;
-; PURPOSE: 
+;
+; @file_comments 
 ;   1) extract from a NetCDF file the longitude, latidude, and their dimensions
 ;      and make sure it is 1D or 2D arrays 
@@ -9 +8 @@
 ;      they are 1D or 2D arrays 
 ;
-; CATEGORY:for interpolations tools
-;
-; CALLING SEQUENCE:
+; @categories interpolation
+;
+; @examples 
 ; 
 ; 1) get_gridparams, file, lonname, latname, lon, lat, jpi, jpj, n_dimensions
@@ -19 +18 @@
 ; 2) get_gridparams, lon, lat, jpi, jpj, n_dimensions
 ;
-; INPUTS:
-;
 ; 1) 
-;  file: the name of the netcdf file
-;  loname: the name of the variable that contains the longitude in the NetCDF file
-;  latname: the name of the variable that contains the latitude in the NetCDF file
+; @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) lon and lat: 1d or 2D arrays defining longitudes and latitudes. 
+; 2) 
+; @param lon lat {in}{required}  1d or 2D arrays defining longitudes and latitudes. 
 ;    Note that these arrays are also outputs and can therefore be modified. 
 
-; KEYWORD PARAMETERS: none
-;
-; OUTPUTS:
-;  lon the variable that will contain the longitudes
-;  lat the variable that will contain the latitudes
-;  jpi the number of points in the longitudinal direction
-;  jpj the number of points in the latitudinal direction
-;  n_dimensions: 1 or 2 to specify if lon and lat should be 1D (jpi or jpj)
+; @param in1 {out} the variable that will contain the longitudes
+;  @param in2  {out} the variable that will contain the latitudes
+;  @param in3  {out} the number of points in the longitudinal direction
+;  @param in4  {out} the number of points in the latitudinal direction
+;  @param in5 {out} 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). 
 ;
-; COMMON BLOCKS: none
-;
-; SIDE EFFECTS: ?
-;
-; RESTRICTIONS: ?
-;
-; EXAMPLE: 
+; @examples  
 ; 
 ; 1) ncdf_get_gridparams, 'coordinates_ORCA_R05.nc', 'glamt', 'gphit' $
@@ -56 +50 @@
 ; 2) ncdf_get_gridparams, olon, olat, jpio, jpjo, 2
 ;
-; MODIFICATION HISTORY:
-;  November 2005: Sebastien Masson (smasson@lodyc.jussieu.fr) 
+; @history
+;  November 2005: Sebastien Masson (smasson\@lodyc.jussieu.fr) 
 ; 
 ;-