Changeset 163 for trunk/SRC/ToBeReviewed/LECTURE/read_ncdf.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/read_ncdf.pro (modified) (6 diffs)

trunk/SRC/ToBeReviewed/LECTURE/read_ncdf.pro

@@ -2 +2 @@
 ; @file_comments
 ; Reading function for the file net_cdf.
-; This program is less universal than ncdf_lec (it appeal to declarated 
+; This program is less universal than ncdf_lec (it appeal to declared 
 ; variables in common.pro) but it is very easier to be used. It considerate
 ; the declaration of the different zooms which have been defined
 ; (ixminmesh...premierx...), the declaration of the variable key_shift...
 ; To put it in a nutshell, the result of read_ncdf can be directly used in plt...
-; This is also this program which is used by default inour reading widgets.  
+; This is also this program which is used by default in our reading widgets.  
 ;
 ; @categories
 ; Reading
 ; 
-; @param NAME {in}{required}
-; It is a string defining the field to be read.
+; @param NAME {in}{required}{type=string}
+; It define the field to be read.
 ;
 ; @param BEGINNING {in}{required}
@@ -21 +21 @@
 ;  which are included between these two dates.
 ;  - 2 indexes which define between which and which time step we have 
-;  to extract the telporal dimension.
+;  to extract the temporal dimension.
 ;
 ; @param ENDING  {in}{required}
@@ -33 +33 @@
 ; Contain the boxzoom on which we have to do the reading 
 ; 
-; @keyword FILENAME
-; It is a string containing the file's name.
+; @keyword FILENAME {type=string}
+; It contains he file's name.
 ; 
 ; @keyword INIT
@@ -41 +41 @@
 ; 
 ; @keyword GRID
-; ='[UTVWF]' to specify the type of grid. Defaut is (1)
+; ='[UTVWF]' to specify the type of grid. Default is (1)
 ; based on the name of the file if the file ends by
 ; GRID[._][TUVFW].NC (not case sensible) or (2) T if case (1)
@@ -57 +57 @@
 ; @keyword NOSTRUCT
 ; We activate it if we do not want that read_ncdf send back a structure 
-; but only the array refering to the field.
-; 
-; @keyword TIMEVAR
-; It is a string which define the name of the variable that
-; contains the time axis. This keyword can be usefull if there
-; is no unlimited dimension or if the time axis selected by defaut
+; but only the array referring to the field.
+; 
+; @keyword TIMEVAR {type=string}
+; It define the name of the variable that
+; contains the time axis. This keyword can be useful if there
+; is no unlimited dimension or if the time axis selected by default
 ; (the first 1D array with unlimited dimension) is not the good one.
 ;
@@ -69 +69 @@
 ;
 ; @returns
-; Structure readable by litchamp.pro or an array if NOSRUCT is activated.
+; Structure readable by litchamp.pro or an array if NOSTRUCT is activated.
 ; 
 ; @uses