Changeset 157 for trunk/SRC/ReadWrite/read_grads.pro

Timestamp:

08/21/06 11:01:50 (18 years ago)

Author:

navarro

Message:

header improvements + xxx doc

File:

• trunk/SRC/ReadWrite/read_grads.pro (modified) (4 diffs)

trunk/SRC/ReadWrite/read_grads.pro

@@ -7 +7 @@
 ; from the grads control file even if there is multiple data files.
 ;
-; @categories reading function
+; @categories 
+; Reading
 ;
 ; @param var {in}{required}
@@ -21 +22 @@
 ; the grads control file name: 'xxxx.ctl'
 ;
-; @file_comments
-; keyword GLAMBOUNDARY (via computegrid.pro) a 2 elements vector,
-; {lon1,lon2], giving the longitude boundaries that should be
-; used to visualize the data.
-;         lon2 > lon1
-;         lon2 - lon1 eq 360
-; key_shift will be automatically defined according to GLAMBOUNDARY.
-;
 ; @keyword TIMESTEP
 ; to specify that the dates are time steps instead of true calendar.
-;
-; @file_comments
-; keyword IODIRECTORY
-; a string giving the name of iodirectory
-; (see isafile.pro for all possibilities).
-; default value is common variable iodir
 ;
 ;---------------
@@ -42 +29 @@
 ;---------------
 ;
-;       BOX a 4 or 6 elements 1d array, [lon1,lon2,lat1,lat2, depth1,
-;       depth2], that specifies the area where data must be read
-;
-;       EVERYTHING
-;
-;       NOSTRUCTURE
+; @keyword BOX
+; A 4 or 6 elements 1d array, [lon1,lon2,lat1,lat2, depth1,
+; depth2], that specifies the area where data must be read
+;
+; @keyword EVERYTHING
+;
+;
+; @keyword NOSTRUCT
+;
+;
+; @keyword _EXTRA
+; Used to pass your keywords
 ;
 ; @returns
 ; an array
 ;
-; @uses common
+; @uses 
+; common
 ;
 ; @restriction
@@ -66 +60 @@
 ; IDL> plt, a
 ;
-; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)
-;
-; @version $Id$
+; @history 
+; Sebastien Masson (smasson\@lodyc.jussieu.fr)
+;
+; @version
+; $Id$
 ;
 ;-