Changeset 375


Ignore:
Timestamp:
08/08/08 17:55:40 (16 years ago)
Author:
pinsard
Message:

improvements of headers (paragraphs and alignments)

Location:
trunk/SRC
Files:
14 edited

Legend:

Unmodified
Added
Removed

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

    r371 r375  
    1313; @param FIELDS {in}{required}{type=string} 
    1414; A string or string array with field names to  
    15 ; be contained in STRUCTURE. CHKSTRU returns 1 (true) 
    16 ; only if all field names are contained in STRUCTURE. 
     15; be contained in STRUCTURE. 
     16; 
     17; CHKSTRU returns 1 (true) only if all field names are contained in STRUCTURE. 
     18; 
    1719; The entries of FIELDS may be upper or lowercase. 
    1820; 
    1921; @keyword INDEX {type=string} 
    2022; A named variable that will contain the indices of 
    21 ; the required field names in the structure. They can then 
    22 ; be assessed through structure.(index[i]) . Index will 
    23 ; contain -1 for all fields entries that are not in the 
    24 ; structure. 
     23; the required field names in the structure.  
     24; 
     25; They can then be assessed through structure.(index[i]).  
     26; 
     27; Index will contain -1 for all fields entries that are not in the structure. 
    2528; 
    2629; @keyword VERBOSE 
    27 ; set this keyword to return an error message  
    28 ; in case of an error. 
     30; set this keyword to return an error message in case of an error. 
    2931; 
    3032; @keyword EXTRACT 
    31 ; set this keyword to extract a fields from the 
    32 ; structure.  -1 is return is fields or structure. are 
    33 ; incorrect. 
     33; set this keyword to extract a field from the structure.   
     34; -1 is return if field or structure are incorrect. 
    3435; 
    3536; @returns 
    36 ; CHKSTRU returns 1 if successful, otherwise 0. 
     37; 1 if successful, otherwise 0. 
    3738; 
    3839; @examples 
    … …  
    4748; 
    4849; @history 
    49 ;        mgs, 02 Mar 1998: VERSION 1.00 
    50 ;        mgs, 07 Apr 1998: - second parameter (FIELDS) now optional 
    51 ;        12 Jan 2001: EXTRACT keyword by S. Masson (smasson\@lodyc.jussieu.fr)  
     50;  - mgs, 02 Mar 1998: VERSION 1.00 
     51;  - mgs, 07 Apr 1998: - second parameter (FIELDS) now optional 
     52;  - 12 Jan 2001: EXTRACT keyword by S. Masson (smasson\@lodyc.jussieu.fr)  
    5253; 
    5354; @version 

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

    r371 r375  
    1818; @keyword DELETE 
    1919; Specify  that the given liste concern elements of STRU to be deleted. 
     20; 
    2021; This keyword is activated by default. 
    2122; 

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

    r371 r375  
    22; 
    33; @file_comments 
    4 ; Concatenate 2 structures together. The difference with CREATE_STRUCT  
    5 ; is  that if the 2 structure have same elements's name, then mixstru  
     4; Concatenate 2 structures together.  
     5; 
     6; The difference with <proidl>CREATE_STRUCT</proidl> 
     7; is that if the 2 structures have same elements's name, then mixstru  
    68; do not break down but choose for the common element the value  
    79; specified by the first structure. 
    … …  
    2224; 
    2325; @restrictions 
    24 ; If STRU1 or  STRU2 is not a structure, mixstru send back -1 
     26; If STRU1 or STRU2 are not structure, mixstru send back -1 
    2527; 
    2628; @examples 

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

    r371 r375  
    22; 
    33; @file_comments 
    4 ; Like WHERE but works on structure tag names 
     4; Like <proidl>WHERE</proidl> but works on structure tag names 
     5; 
    56; Obtain subscripts of elements in structure array for which 
    67; a particular Tag has values in a range or matching specified values. 
    7 ; Like the WHERE function but for use with structures 
     8; 
     9; Like the <proidl>WHERE</proidl> function but for use with structures 
    810;  
    911; @categories 
    … …  
    1719;  
    1820; @keyword TAG_NUMBER 
    19 ; Otherwise give the Tag Number, 
     21; Otherwise give the Tag Number 
    2022;  
    2123; @keyword RANGE 
    22 ;  [min,max] range to search for in Struct 
     24; [min,max] range to search for in STRUCT 
    2325;  
    2426; @keyword VALUES 
    25 ; One or array of numbers to match for in Struct, 
     27; One or array of numbers to match for in STRUCT 
    2628;  
    2729; @keyword ISELECT 
    … …  
    3840; @restrictions 
    3941; User *must* specify (1) TAG_NAME or TAG_NUMBER to search, and (2) 
    40 ; the VALUES or RANGE to search on; 
     42; the VALUES or RANGE to search on. 
    4143; 
    4244; @examples 

  • trunk/SRC/Utilities/createfunc.pro

    r371 r375  
    1515; to specify a list of keywords that must be included in the  
    1616; function definition.  
     17; 
    1718; Warning: the string must start with a ','  
    1819; for example: KWDLIST=', TOTO=toto' 

  • trunk/SRC/Utilities/createpro.pro

    r371 r375  
    1414; to specify a list of keywords that must be included in the procedure  
    1515; definition.  
     16; 
    1617; Warning: the string must start with a ','  
    1718; for example: KWDLIST=', TOTO = toto' 
    … …  
    3839; @history 
    3940; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    40 ; cleaning + new keywords: October 2005 
    41 ; Feb. 2006: supress keyword "kwdused" and use call_procedure instead of execute 
     41;  - cleaning + new keywords: October 2005 
     42;  - Feb. 2006: supress keyword "kwdused" and use call_procedure instead of  
     43;    execute 
    4244; 
    4345; @version 

  • trunk/SRC/Utilities/find.pro

    r371 r375  
    55; a set of possibles names and a different set of 
    66; possibles directories names. 
     7; 
    78; By default look for files included in !path 
    89; 
    … …  
    100101; @history 
    101102; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    102 ;                      28/4/1999 
    103 ;                      6/7/1999: compatibility mac and windows 
    104 ; June 2005: Sebastien Masson: cleaning, use for file_* functions 
     103;  - 28/4/1999 
     104;  - 6/7/1999: compatibility mac and windows 
     105;  - June 2005: Sebastien Masson: cleaning, use for file_* functions 
    105106; 
    106107; @version 

  • trunk/SRC/Utilities/fitintobox.pro

    r371 r375  
    3030; @history 
    3131; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    32 ;          10 juin 2000. 
    33 ;          June 2005: S. Masson rewrite all. 
     32;  - 10 juin 2000. 
     33;  - June 2005: S. Masson rewrite all. 
    3434; 
    3535; @version 

  • trunk/SRC/Utilities/lineintersection.pro

    r371 r375  
    2424; @returns 
    2525; 2 possibilities: 
    26 ;      1) by default: it is a vector of complex whose each element is the coordinates 
    27 ;                     of the intersection point of a pair of straight lines. 
    28 ;      2) if FLOAT is activated, it is a array of reals of dimension 2, 
    29 ;         number_of_pairs_of_straight_lines whose each row is the coordinates 
    30 ;         of the intersection point of a pair of straight line. 
     26;  1) by default: it is a vector of complex whose each element is the  
     27;     coordinates of the intersection point of a pair of straight lines. 
     28;  2) if FLOAT is activated, it is a array of reals of dimension 2, 
     29;     number_of_pairs_of_straight_lines whose each row is the coordinates 
     30;     of the intersection point of a pair of straight line. 
    3131; 
    3232; @restrictions 

  • trunk/SRC/Utilities/report.pro

    r372 r375  
    44; Like <proidl>DIALOG_MESSAGE</proidl> if there is already some widget 
    55; active or like <proidl>MESSAGE</proidl> if there is not any widget active. 
     6; 
    67; To ask a question whose answer is not yes/no, use <pro>xquestion</pro>. 
    78; 
    89; @param textin {in}{required} {type=scalar string or arrays of string} 
    910; If textin is a scalar string, we look for the line feed character "!C". 
     11; 
    1012; If textin is set to an array of strings, each 
    1113; array element is displayed as a separate line of text. 

  • trunk/SRC/Utilities/text_box.pro

    r327 r375  
    2020; 
    2121; @keyword BG_COLOR 
    22 ; background color. Setting BG_COLOR erases the area 
    23 ;               covered by the text box (filling it with color BG_COLOR) 
    24 ;               prior to writing the text.  If both BG_COLOR and !p.color 
    25 ;               are zero then the background color is reset to 255 to 
    26 ;               guarantee a readability. 
     22; background color.  
     23; Setting BG_COLOR erases the area 
     24; covered by the text box (filling it with color BG_COLOR) 
     25; prior to writing the text. If both BG_COLOR and !p.color 
     26; are zero then the background color is reset to 255 to 
     27; guarantee a readability. 
    2728; 
    2829; @keyword RIGHT 

  • trunk/SRC/Utilities/undefine.pro

    r371 r375  
    33; @file_comments 
    44; erase a variable 
     5; 
    56; same thing like <proidl>DELVAR</proidl> but usable in a program and usable 
    67; for one variable simultaneously 
    … …  
    3738  compile_opt idl2, strictarrsubs 
    3839; 
    39    tempvar = SIZE(TEMPORARY(varname)) 
    40    END 
     40  tempvar = SIZE(TEMPORARY(varname)) 
     41END 

  • trunk/SRC/Utilities/xfile.pro

    r371 r375  
    33; @file_comments 
    44; display an ASCII file in a widget. 
     5; 
    56; It is the same thing that <proidl>XDISPLAYFILE</proidl> but here, we use it 
    67; to display the content of a procedure or of a function located in the !path 

  • trunk/SRC/Utilities/xhelp.pro

    r371 r375  
    3030;       Institute for Computational Earth System Science 
    3131;       University of California, Santa Barbara 
    32 ;  7/1/99 : legeres modification par Sebastien Masson : utilisation de 
    33 ;  <proidl>xdisplayfile</proidl>, de <pro>findfile</pro> et de _extra. 
    34 ;  6/7/1999: compatibility mac and windows 
     32;  - 7/1/99 : legeres modification par Sebastien Masson : utilisation de 
     33;    <proidl>xdisplayfile</proidl>, de <pro>findfile</pro> et de _extra. 
     34;  - 6/7/1999: compatibility mac and windows 
    3535; 
    3636; @version 
Note: See TracChangeset for help on using the changeset viewer.