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

trunk/SRC/ToBeReviewed/LECTURE/litchamp.pro

@@ -5 +5 @@
 ;
 ; @file_comments
-; Allows to read an array or a sructure cooresponding to a field.
+; Allows to read an array or a structure corresponding to a field.
 ; If we have in input: 
 ;   -an array, litchamp send back the array.
@@ -17 +17 @@
 ; Graphics
 ;
-; @param STRUCT {in}{required}
-; It is either an array or a structure.
+; @param STRUCT {in}{required}{type=array or struct}{type=array or structure}
 ;  If STRUCT is a structure, it must follow following rules:
 ;        -the first element is the array containing the field.
-;        -other elements are strings containing informations on the field exept
+;        -other elements are strings containing informations on the field except
 ;        for the one about the date. This one can be either a string to designate
 ;        a particular date (ex: 'August 1999') or a vector of julian days (of IDL)
 ;        corresponding  to the calendar to be associated with the field if it is a
 ;        temporal series.
-;        -the order of elements (exept the first) has not any importance. 
-;        -the other elements (exept the first) are optional.
+;        -the order of elements (except the first) has not any importance. 
+;        -the other elements (except the first) are optional.
 ;        -they are recognize by the first letter of their names:
 ;             g  to update vargrid
@@ -66 +65 @@
 ; and -1 if it does not.
 ; 
-;
 ; @keyword MASK
 ; We activate this keyword if we want litchamp to send back the variable