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

trunk/SRC/ReadWrite/read_grads.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:read_grads
-;
-; PURPOSE:reading grads file (except "data type station" or "grib")
+; @file_comments reading grads file (except "data type station" or "grib")
 ; from the grads control file even if there is multiple data files.
 ;
-; CATEGORY:reading function
-;
-; CALLING SEQUENCE: 
-;       res=read_grads(var, date1 [, date2], FILENAME = filename)
-; 
-; INPUTS:
-;       var: the variable name
-;       date1: date of the beginning (yyyymmdd if TIMESTEP is not activate)
-;       date2: last date. Optionnal, if not scpecified date2=date1
+; @categories reading function
+;
+;       @param var {in}{required} the variable name
+;       @param date1 {in}{required} date of the beginning (yyyymmdd if TIMESTEP is not activate)
+;       @param date2 {in}{optional} last date. Optionnal, if not scpecified date2=date1
 ;      
-; KEYWORD PARAMETERS:
-;       
-;       FILENAME: the grads control file name: 'xxxx.ctl'
-;
-;       GLAMBOUNDARY (via computegrid.pro):a 2 elements vector,
+; @keyword FILENAME the grads control file name: 'xxxx.ctl'
+;
+; @file_comments keyword GLAMBOUNDARY (via computegrid.pro) a 2 elements vector,
 ;       {lon1,lon2], giving the longitute boundaries that should be
 ;       used to visualize the data.
@@ -30 +22 @@
 ;       GLAMBOUNDARY.
 ;
-;       /TIMESTEP: to specify that the dates are time steps instead of 
+;       @keyword /TIMESTEP to specify that the dates are time steps instead of 
 ;       true calendar.
 ;
-;       IODIRECTORY;a string giving the name of iodirectory (see
+;        @file_comments keyword IODIRECTORY a string giving the name of iodirectory (see
 ;       isafile.pro for all possibilities). default value is common 
 ;       variable iodir
 ;
+; @file_comments
 ;---------------
 ; NOT yet available
 ;---------------
 ;
-;       BOX: a 4 or 6 elements 1d array, [lon1,lon2,lat1,lat2, depth1, 
+;       @hidden BOX: a 4 or 6 elements 1d array, [lon1,lon2,lat1,lat2, depth1, 
 ;       depth2], that specifies the area where data must be read
 ;
-;       EVERYTHING
+;       @hidden EVERYTHING
 ; 
-;       NOSTRUCTURE
+;       @hidden NOSTRUCTURE
 ;       
-; OUTPUTS: an array
-;
-; COMMON BLOCKS:common.pro
-;
-; SIDE EFFECTS:define all the grid parameters (defined in common.pro)
+; @returns an array
+;
+; @uses common
+;
+; @restriction define all the grid parameters (defined in common.pro)
 ; associated to the data.
 ;
-; RESTRICTIONS: this function call the procedure scanfile that use the 
+; @restrictions this function call the procedure scanfile that use the 
 ; unix commands grep and sed 
 ;
-; EXAMPLE:
+; @examples
 ;    IDL> a=read_grads('sst',19900101,19900131,filename='outputs.ctl')
 ;    IDL> plt, a
 ;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ;
 ;-