Changeset 163 for trunk/SRC/ToBeReviewed/LECTURE/xncdf_lec.pro

Timestamp:

08/29/06 14:59:46 (18 years ago)

Author:

navarro

Message:

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)

File:

• trunk/SRC/ToBeReviewed/LECTURE/xncdf_lec.pro (modified) (3 diffs)

trunk/SRC/ToBeReviewed/LECTURE/xncdf_lec.pro

@@ -10 +10 @@
 ; Widget
 ;
-; @param NAME {in}{optional}
-; It is a string giving the name of the file to be opened. If NAME 
+; @param NAME {in}{optional}{type=string} 
+; It give the name of the file to be opened. If NAME 
 ; does not contain the separating character of directories ('/' under 
 ; unix for example), the file will be looked for in the current directory.
 ;
-; @keyword IODIR
-; It is a string containing the directory where to go look for the file to be read.
+; @keyword IODIR {type=string}
+; It contains the directory where to go look for the file to be read.
 ; If NAME does not contain the separating character of directories ('/' under 
 ; unix for example), the file will be called iodir+nom_fichier.
 ;
-; @keyword COUNT
+; @keyword COUNT {type=vector}
 ; An optional vector containing the counts to be used in
 ; reading Value. COUNT is a 1-based vector with an element for
@@ -31 +31 @@
 ; of XNCDF_LEC. 
 ;
-; @keyword OFFSET
+; @keyword OFFSET {type=vector}{default=[0, 0,...]}
 ; An optional vector containing the starting position
 ; for the read. The default start position is [0, 0, ...].
 ;
-; @keyword SHIFT
-; A vector of integers, specifing for each dimension how much we have to shift it. 
+; @keyword SHIFT {type=vector}{default=[0, 0,...]}
+; A vector of integers, specifying for each dimension how much we have to shift it. 
 ; By default, it is [0,0,...]. See the function shift for more explanations. BEWARE, 
-; the shift is done on the biggest array before a possible reduction determinated 
+; the shift is done on the biggest array before a possible reduction determined 
 ; by OFFSET and COUNT. On the other hand, it is done after the possible extraction 
 ; created by the STRIDE.
 ;
-; @keyword STRIDE
+; @keyword STRIDE {type=vector}{default=[1, 1,...]}
 ; An optional vector containing the strides, or sampling
 ; intervals, between accessed values of the netCDF variable. The
@@ -388 +388 @@
 ; This widget concern the reading of the variable.
 ;
-; @param WIDID_PERE {in}{required}
-; It is a scalar containing the identity of the father widget which was 
+; @param WIDID_PERE {type=scalar}{in}{required}
+; It contains the identity of the father widget which was 
 ; created by xncdf_lec and which has allowed to select the variable to be read.
 ;