Ignore:
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)

Location:
trunk/SRC/ToBeReviewed/STRUCTURE
Files:
5 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/ToBeReviewed/STRUCTURE/chkstru.pro

    r157 r163  
    88; Utilities 
    99; 
    10 ; @param  STRUCTURE {in}{required} 
     10; @param STRUCTURE {in}{required}{type=struct} 
    1111; The structure to be tested. If STRUCTURE is 
    1212; not of type structure, the function will return 0 
    1313; 
    14 ; @param FIELDS {in}{required} 
     14; @param FIELDS {in}{required}{type=string} 
    1515; A string or string array with field names to  
    1616; be contained in STRUCTURE. CHKSTRU returns 1 (true) 
    … …  
    1818; The entries of FIELDS may be upper or lowercase. 
    1919; 
    20 ; @keyword INDEX 
     20; @keyword INDEX {type=string} 
    2121; A named variable that will contain the indices of 
    2222; the required field names in the structure. They can then 

  • trunk/SRC/ToBeReviewed/STRUCTURE/extractstru.pro

    r157 r163  
    1212; A structure 
    1313; 
    14 ; @param LISTE {in}{required} 
     14; @param LISTE {in}{required}{type=vector} 
    1515; A vector of string including names of STRU to be deleted  
    1616; (by default) or to be kept (if KEEP is activated). 
    … …  
    1919; Specify that the given liste concern elements of STRU to be kept. 
    2020; 
    21 ; @keyword DELETE: 
     21; @keyword DELETE 
    2222; Specify  that the given liste concern elements of STRU to be deleted. 
    2323; This keyword is activated by default. 

  • trunk/SRC/ToBeReviewed/STRUCTURE/mixstru.pro

    r157 r163  
    2222; 
    2323; @returns 
    24 ; A stucture 
     24; A structure 
    2525; 
    2626; @restrictions 

  • trunk/SRC/ToBeReviewed/STRUCTURE/struct2string.pro

    r157 r163  
    1313; A structure 
    1414; 
    15 ; @keyword MAX_STRUCT_LENGTH 
     15; @keyword MAX_STRUCT_LENGTH {default=10000l} 
    1616; The maximum length of the structure 
    17 ; permetted to convert the structure to string. Default is 
    18 ; 10000l. 
     17; permetted to convert the structure to string. 
    1918; 
    2019; @keyword DIRECT2STRING 

  • trunk/SRC/ToBeReviewed/STRUCTURE/where_tag.pro

    r157 r163  
    3333; @returns 
    3434; Nfound {out} 
    35 ; # of occurences found. 
     35; # of occurrences found. 
    3636;  
    3737; @restrictions 
    … …  
    5555;  
    5656;- 
    57 function where_Tag, Struct, Nfound,     TAG_NAME=Tag_Name,      $ 
     57function where_tag, Struct, Nfound,     TAG_NAME=Tag_Name,      $ 
    5858                                        TAG_NUMBER=Tag_Num,     $ 
    5959                                        ISELECT=ipart, NOPRINT=noprint, $ 
Note: See TracChangeset for help on using the changeset viewer.