Changeset 150 for trunk/SRC/ToBeReviewed/STRUCTURE/chkstru.pro

Timestamp:

08/09/06 12:12:54 (18 years ago)

Author:

navarro

Message:

english and nicer header (3a)

File:

• trunk/SRC/ToBeReviewed/STRUCTURE/chkstru.pro (modified) (2 diffs)

trunk/SRC/ToBeReviewed/STRUCTURE/chkstru.pro

@@ -1 @@
-; $Id$
 ;-------------------------------------------------------------
 ;+
-; NAME:
-;        CHKSTRU  (function)
+; @file_comments
+; check validity of a structure and test if necessary
+; fields are contained
 ;
-; PURPOSE:
-;        check validity of a structure and test if necessary
-;        fields are contained
+; @categories
+; tools
 ;
-; CATEGORY:
-;        tools
+; @param  STRUCTURE {in}{required}
+; The structure to be tested. If STRUCTURE is
+; not of type structure, the function will return 0
 ;
-; CALLING SEQUENCE:
-;        res=CHKSTRU(STRUCTURE,FIELDS [,/VERBOSE]) 
+; @param FIELDS {in}{required}
+; 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.
+; The entries of FIELDS may be upper or lowercase.
 ;
-; INPUTS:
-;        STRUCTURE --> the structure to be tested. If STRUCTURE is
-;             not of type structure, the function will return 0
+; @keyword INDEX
+; 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.
 ;
-;        FIELDS --> 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.
-;             The entries of FIELDS may be upper or lowercase.
+; @keyword VERBOSE
+; set this keyword to return an error message 
+; in case of an error.
 ;
-; KEYWORD PARAMETERS:
-;        INDEX --> 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.
+; @keyword EXTRACT
+; set this keyword to extract a fields from the
+; structure.  -1 is return is fields or structure. are
+; incorrect.
 ;
-;        /VERBOSE --> set this keyword to return an error message 
-;             in case of an error.
+; @returns
+; CHKSTRU returns 1 if successful, otherwise 0.
 ;
-;        /EXTRACT --> set this keyword to extract a fields from the
-;        structure.  -1 is return is fields or structure. are
-;        incorrect.
-;
-; OUTPUTS:
-;        CHKSTRU returns 1 if successful, otherwise 0.
-;
-; SUBROUTINES:
-;
-; REQUIREMENTS:
-;
-; NOTES:
-;
-; EXAMPLE:
+; @examples
 ;        test = { a:1, b:2, c:3 }
 ;        required = ['a','c']
@@ -56 +46 @@
 ;               2
 ;
-; MODIFICATION HISTORY:
+; @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) 
+;
+; @version
+; $Id$
 ;
 ;-