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

Timestamp:

08/12/08 14:35:46 (16 years ago)

Author:

pinsard

Message:

improvements of headers (typo, links, paragraphes, etc)

File:

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

trunk/SRC/ToBeReviewed/LECTURE/xncdf_lec.pro

@@ -8 +8 @@
 ;
 ; @param NAME {in}{optional}{type=string}
-; It give the name of the file to be opened. If NAME
+; 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.
@@ -14 +16 @@
 ; @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 {type=vector}
-; An optional vector containing the counts to be used in
-; reading Value. COUNT is a 1-based vector with an element for
-; each dimension of the data to be written.The default matches
+; An optional vector containing the counts to be used in reading Value. 
+;
+; COUNT is a 1-based vector with an element for
+; each dimension of the data to be written.
+;
+; The default matches
 ; the size of the variable so that all data is written out.
 ;
 ; @keyword GROUP
-; The widget ID of the widget that calls XNCDF_LEC. When
-; this ID is specified, a death of the caller results in a death
+; The widget ID of the widget that calls XNCDF_LEC. 
+;
+; When this ID is specified, a death of the caller results in a death
 ; of XNCDF_LEC.
 ;
 ; @keyword OFFSET {type=vector}{default=[0, 0,...]}
 ; An optional vector containing the starting position
-; for the read. The default start position is [0, 0, ...].
+; for the read.
 ;
 ; @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 <proidl>shift</proidl> for more explanations. BEWARE,
+;
+; See the function <proidl>SHIFT</proidl> for more explanations. 
+;
+; BEWARE,
 ; 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
+; by OFFSET and COUNT. 
+;
+; On the other hand, it is done after the possible extraction
 ; created by the 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
-; default stride vector is that for a contiguous read, [1, 1,...].
+; intervals, between accessed values of the netCDF variable.
 ;
 ; @returns
 ;  2 different cases:
-;       1) None attribute has been selected. In this case, res is the array we
-;       wanted to read.
-;       2) Some attributes has been selected. In this case, res is a structure
-;       whose the first element having the name of the variable is the values
-;       array and the other arguments are the select arguments.
+;  1) None attribute has been selected. In this case, res is the array we
+;     wanted to read.
+;  2) Some attributes has been selected. In this case, res is a structure
+;     whose the first element having the name of the variable is the values
+;     array and the other arguments are the select arguments.
 ;
 ; @uses
@@ -387 +398 @@
 ; created by xncdf_lec and which has allowed to select the variable to be read.
 ;
-; @results
+; @returns
 ; indirectement res (le tableau ou la structure resultat)
 ;