Changeset 375 for trunk/SRC/ToBeReviewed

Timestamp:

08/08/08 17:55:40 (16 years ago)

Author:

pinsard

Message:

improvements of headers (paragraphs and alignments)

Location:

trunk/SRC/ToBeReviewed/STRUCTURE

Files:

• chkstru.pro (modified) (2 diffs)
• extractstru.pro (modified) (1 diff)
• mixstru.pro (modified) (2 diffs)
• where_tag.pro (modified) (3 diffs)

trunk/SRC/ToBeReviewed/STRUCTURE/chkstru.pro

@@ -13 +13 @@
 ; @param FIELDS {in}{required}{type=string}
 ; A string or string array with field names to 
-; be contained in STRUCTURE. CHKSTRU returns 1 (true)
-; only if all field names are contained in STRUCTURE.
+; be contained in STRUCTURE.
+;
+; CHKSTRU returns 1 (true) only if all field names are contained in STRUCTURE.
+;
 ; The entries of FIELDS may be upper or lowercase.
 ;
 ; @keyword INDEX {type=string}
 ; A named variable that will contain the indices of
-; the required field names in the structure. They can then
-; be assessed through structure.(index[i]) . Index will
-; contain -1 for all fields entries that are not in the
-; structure.
+; the required field names in the structure. 
+;
+; They can then be assessed through structure.(index[i]). 
+;
+; Index will contain -1 for all fields entries that are not in the structure.
 ;
 ; @keyword VERBOSE
-; set this keyword to return an error message 
-; in case of an error.
+; set this keyword to return an error message in case of an error.
 ;
 ; @keyword EXTRACT
-; set this keyword to extract a fields from the
-; structure.  -1 is return is fields or structure. are
-; incorrect.
+; set this keyword to extract a field from the structure.  
+; -1 is return if field or structure are incorrect.
 ;
 ; @returns
-; CHKSTRU returns 1 if successful, otherwise 0.
+; 1 if successful, otherwise 0.
 ;
 ; @examples
@@ -47 +48 @@
 ;
 ; @history
-;        mgs, 02 Mar 1998: VERSION 1.00
-;        mgs, 07 Apr 1998: - second parameter (FIELDS) now optional
-;        12 Jan 2001: EXTRACT keyword by S. Masson (smasson\@lodyc.jussieu.fr) 
+;  - mgs, 02 Mar 1998: VERSION 1.00
+;  - mgs, 07 Apr 1998: - second parameter (FIELDS) now optional
+;  - 12 Jan 2001: EXTRACT keyword by S. Masson (smasson\@lodyc.jussieu.fr) 
 ;
 ; @version

trunk/SRC/ToBeReviewed/STRUCTURE/extractstru.pro

@@ -18 +18 @@
 ; @keyword DELETE
 ; Specify  that the given liste concern elements of STRU to be deleted.
+;
 ; This keyword is activated by default.
 ;

trunk/SRC/ToBeReviewed/STRUCTURE/mixstru.pro

@@ -2 +2 @@
 ;
 ; @file_comments
-; Concatenate 2 structures together. The difference with CREATE_STRUCT 
-; is  that if the 2 structure have same elements's name, then mixstru 
+; Concatenate 2 structures together. 
+;
+; The difference with <proidl>CREATE_STRUCT</proidl>
+; is that if the 2 structures have same elements's name, then mixstru 
 ; do not break down but choose for the common element the value 
 ; specified by the first structure.
@@ -22 +24 @@
 ;
 ; @restrictions
-; If STRU1 or  STRU2 is not a structure, mixstru send back -1
+; If STRU1 or STRU2 are not structure, mixstru send back -1
 ;
 ; @examples

trunk/SRC/ToBeReviewed/STRUCTURE/where_tag.pro

@@ -2 +2 @@
 ;
 ; @file_comments
-; Like WHERE but works on structure tag names
+; Like <proidl>WHERE</proidl> but works on structure tag names
+;
 ; Obtain subscripts of elements in structure array for which
 ; a particular Tag has values in a range or matching specified values.
-; Like the WHERE function but for use with structures
+;
+; Like the <proidl>WHERE</proidl> function but for use with structures
 ; 
 ; @categories
@@ -17 +19 @@
 ; 
 ; @keyword TAG_NUMBER
-; Otherwise give the Tag Number,
+; Otherwise give the Tag Number
 ; 
 ; @keyword RANGE
-;  [min,max] range to search for in Struct
+; [min,max] range to search for in STRUCT
 ; 
 ; @keyword VALUES
-; One or array of numbers to match for in Struct,
+; One or array of numbers to match for in STRUCT
 ; 
 ; @keyword ISELECT
@@ -38 +40 @@
 ; @restrictions
 ; User *must* specify (1) TAG_NAME or TAG_NUMBER to search, and (2)
-; the VALUES or RANGE to search on;
+; the VALUES or RANGE to search on.
 ;
 ; @examples