Changeset 242 for trunk/SRC/Utilities


Ignore:
Timestamp:
04/06/07 10:35:17 (17 years ago)
Author:
pinsard
Message:

improvements/corrections of some *.pro headers + replace some message by some report

Location:
trunk/SRC/Utilities
Files:
15 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Utilities/createfunc.pro

    r239 r242  
    55; useful to avoid the use of execute 
    66; 
    7 ; @param command {in}{required}  
    8 ; a scalar string defining the result to be given back by the function.  
     7; @param command {in}{required} {type=scalar string} 
     8; defining the result to be given back by the function.  
    99; (see examples) 
    1010; 
    … …  
    1212; name of the function to be created. 
    1313; 
    14 ; @keyword KWDLIST {in}  
    15 ; a vector string. to specify a list of keywords that must be included in the  
     14; @keyword KWDLIST {in} {type=vector string}  
     15; to specify a list of keywords that must be included in the  
    1616; function definition.  
    1717; Warning: the string must start with a ','  

  • trunk/SRC/Utilities/createpro.pro

    r239 r242  
    55; 
    66; @param command {in}{required}{type=string array} 
    7 ; a string array defining the procedure to be created.  
     7; array defining the procedure to be created.  
    88; each element will be a line of the created procedure. 
    99; 
    … …  
    1111; name of the procedure to be created. 
    1212; 
    13 ; @keyword KWDLIST {in}  
    14 ; a vector string.  
     13; @keyword KWDLIST {in} {type=vector string} 
    1514; to specify a list of keywords that must be included in the procedure  
    1615; definition.  
    … …  
    2524; 
    2625; @restrictions 
    27 ; - is not working with functions, use createfunc instead. 
     26; - is not working with functions, use <pro>createfunc</pro> instead. 
    2827; - arguments can be given only through keywords. 
    2928; - ends the procedure name with '.pro' if needed. 
    … …  
    4342; @version 
    4443; $Id$ 
     44; 
    4545;- 
    4646; 

  • trunk/SRC/Utilities/find.pro

    r239 r242  
    77; By default look for files included in !path 
    88; 
    9 ; all file_search keywords can be used. 
     9; all <proidl>file_search</proidl> keywords can be used. 
    1010; 
    1111; @categories 
    1212; find a file 
    1313; 
    14 ; @param FILEIN {in}{required} 
    15 ; A scalar or array variable of string type, containing 
    16 ; file names to match. Input names specifications may contain 
     14; @param FILEIN {in}{required} {type=scalar string or array of strings} 
     15; File name[s] to match. Input names specifications may contain 
    1716; wildcard characters, enabling them to match multiple files 
    18 ; (see file_search for more informations). By default and if 
    19 ; necessary, find is looking for filename and also for filename 
     17; (see <proidl>file_search</proidl> for more informations). By default and if 
     18; necessary, <pro>find</pro> is looking for filename and also for filename 
    2019; completed with '.pro' 
    2120; 
    … …  
    2322; activate this keyword to stop looking for the file as soon as we found one. 
    2423; 
    25 ; @keyword IODIRECTORY {default=['.',!path]} 
    26 ; A scalar or array variable of string type, containing 
    27 ; directories names where we are looking for the file. 
     24; @keyword IODIRECTORY {type=scalar string or array of strings} {default=['.',!path]} 
     25; Directories names where we are looking for the file. 
    2826; Different directories can be separated by 
    2927; path_sep(/search_path) (':' on unix type machine) as it is done 
    … …  
    4745; @keyword RECURSIVE 
    4846; performs recursive searching of directory hierarchies. 
    49 ; In a recursive search, find looks recursively for any and all 
     47; In a recursive search, <pro>find</pro> looks recursively for any and all 
    5048; subdirectories in the file hierarchy rooted at the IODIRECTORY argument. 
    5149; 
    5250; @keyword REPERTOIRE 
    53 ; obsolete. keep for compatibility, use directory keyword 
     51; obsolete. keep for compatibility, use IODIRECTORY keyword 
    5452; 
    5553; @keyword UNIQUE 
    … …  
    5755; 
    5856; @keyword TRYFIND 
    59 ; if the file was not found and this keyword is activated, find will call 
     57; if the file was not found and this keyword is activated, <pro>find</pro>  
     58; will call 
    6059; itself with the keywords /LOOKALLDIR and /FIRSTFOUND to try to find 
    6160; the file we are looking for. Note that if the file was found at the 
    … …  
    6867; A scalar or array variable of string type, containing the 
    6968; name (with the full path of the matching files. If no files 
    70 ; exist with names matching the input arguments, find returns 
     69; exist with names matching the input arguments, <pro>find</pro> returns 
    7170; the scalar string : 'NOT FOUND' 
    7271; 
    7372; @examples 
    74 ; 
    7573; IDL> print, find('*loadct') 
    7674;   /usr/local/rsi/idl_6.0/lib/utilities/xloadct.pro 
    … …  
    106104; @version 
    107105; $Id$ 
     106; 
    108107;- 
    109108; 
    … …  
    112111               , ONLYNC = onlync, UNIQUE = unique, FIRSTFOUND = firstfound $ 
    113112               , LOOKALLDIR = LOOKALLDIR, TRYFIND = tryfind, _EXTRA = ex 
    114 ; define where we look for the file 
    115113; 
    116114  compile_opt idl2, strictarrsubs 
    117115; 
     116; define where we look for the file 
    118117  cd, current = current 
    119118  current = (file_search(current, /test_directory, /mark_directory))[0] 

  • trunk/SRC/Utilities/isafile.pro

    r237 r242  
    33; @file_comments 
    44; same as <pro>find</pro> except that as long as the file is 'NOT FOUND', 
    5 ; isafile calls dialog_pickfile, to ask the user to select a file. 
     5; <pro>isafile</pro> calls  
     6; <proidl>dialog_pickfile</proidl>, to ask the user to select a file. 
    67; 
    78; @categories 
    … …  
    3233; @keyword RECURSIVE 
    3334; performs recursive searching of directory hierarchies. 
    34 ; In a recursive search, find looks recursively for any and all 
     35; In a recursive search, <pro>find</pro> looks recursively for any and all 
    3536; subdirectories in the file hierarchy rooted at the IODIRECTORY argument. 
    3637; 
    … …  
    4445; 
    4546; @examples 
    46 ; 
    4747; IDL> print, isafile('/Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro') 
    4848;  /Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro 

  • trunk/SRC/Utilities/linearequation.pro

    r231 r242  
    1010; 
    1111; @param POINT1 {in}{required} 
    12 ; This is the first point of(the) straight line(s) whose we want to calculate 
     12; This is the first point of (the) straight line(s) whose we want to calculate 
    1313; equation(s) 
    1414; 
    1515; @param POINT2 {in}{required} 
    16 ; This is the second point of(the) straight line(s) whose we want to calculate 
     16; This is the second point of (the) straight line(s) whose we want to calculate 
    1717; equation(s) 
    1818; 

  • trunk/SRC/Utilities/lineintersection.pro

    r231 r242  
    1010; @param ABC1 {in}{required}{type=3d array} 
    1111; is the first array of dimension 3, number_of_pairs_of_straight_lines, 
    12 ; whose each line contain the 3 parameters a,b and c of the first linear 
     12; whose each line contain the 3 parameters a, b and c of the first linear 
    1313; equation of the type ax+by+c=0 
    1414; 
    1515; @param ABC2 {in}{required}{type=3d array} 
    1616; is second array of dimension 3, number_of_pairs_of_straight_lines, 
    17 ; whose each line contain the 3 parameters a,b and c of the second linear 
     17; whose each line contain the 3 parameters a, b and c of the second linear 
    1818; equation of the type ax+by+c=0 
    1919; 
    … …  
    2626;      1) by default: it is a vector of complex whose each element is the coordinates 
    2727;                     of the intersection point of a pair of straight lines. 
    28 ;      2) if FLOAT is activated, it is a array of reels of dimension 2, 
     28;      2) if FLOAT is activated, it is a array of reals of dimension 2, 
    2929;         number_of_pairs_of_straight_lines whose each row is the coordinates 
    3030;         of the intersection point of a pair of straight line. 
    3131; 
    3232; @restrictions 
    33 ; If the 2 straight line are parallel, we return coordinates 
     33; If the 2 straight lines are parallel, we return coordinates 
    3434; (!values.f_nan,!values.f_nan) 
    3535; 

  • trunk/SRC/Utilities/mergeonline_help.pro

    r239 r242  
    1515; @version 
    1616; $Id$ 
     17; 
    1718;- 
    1819; 
    … …  
    2425  idlversion = float(strmid(!version.release, 0, 3)) 
    2526  IF idlversion LT 6.2 THEN BEGIN 
    26     print, 'Warning: You need at least IDL 6.2 to use SAXO/IDL merged online help' 
     27    ras = report('Warning: You need at least IDL 6.2 to use SAXO/IDL merged online help') 
    2728    return 
    2829  ENDIF 
    … …  
    170171  putfile, homesrc + 'aboutsaxo.txt', temporary(about) 
    171172;--------------------------------------------------------------- 
    172   print, 'Merge of SAXO and IDL online help done...' 
     173  ras = report('Merge of SAXO and IDL online help done...') 
    173174  !help_path = homesrc 
    174175; 
    175176  RETURN 
    176 END 
     177  END 

  • trunk/SRC/Utilities/protype.pro

    r231 r242  
    3333; @version 
    3434; $Id$ 
     35; 
    3536;- 
    3637; 
    3738FUNCTION protype, file 
    38 ; 
    3939; 
    4040  compile_opt idl2, strictarrsubs 

  • trunk/SRC/Utilities/report.pro

    r239 r242  
    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 ; To ask a question whose answer is not yes/no,use xquestion. 
     6; To ask a question whose answer is not yes/no, use xquestion. 
    77; 
    8 ; @param TEXT {in}{required} 
    9 ; one string or one vector of string. Si le string ne 
     8; @param TEXT {in}{required} {type=scalar string or arrays of string} 
     9; If TEXT is a scalar string, we look for the line feed characters "!C" 
    1010; comporte qu''un element, on cherche les eventuels caracteres de 
    1111; retour a la ligne: '!C'. If text is set to an array of strings, each 
    … …  
    1414; @keyword SIMPLE 
    1515; activate to print only the message without the name 
    16 ; and the line of the routine (defined by calling routine_name) 
    17 ; 
    18 ; @keyword _EXTRA 
    19 ; Used to pass keywords to <proidl>dialog_message</proidl> and  
    20 ; <proidl>message</proidl> 
     16; and the line of the routine (defined by calling <pro>routine_name</pro>) 
     17; or++  
     18; Activate to print the error message without printing the routine name with 
     19; its full path. 
    2120; 
    2221; @keyword PARENT 
    … …  
    3029; "Question" dialog. 
    3130; 
    32 ; @keyword SIMPLE 
    33 ; Activate to print the error message without printing the routine name with 
    34 ; its full path. 
     31; @keyword _EXTRA 
     32; Used to pass keywords to <proidl>dialog_message</proidl> and  
     33; <proidl>message</proidl> 
    3534; 
    3635; @returns 

  • trunk/SRC/Utilities/routine_name.pro

    r231 r242  
    1616; 
    1717; @restrictions 
    18 ; This function use the keyword OUTPUT in help.pro and it is specified 
     18; This function use the keyword OUTPUT in <proidl>help</proidl> and  
     19; it is specified 
    1920; in the on-line help that the return syntax of this word can change in 
    2021; function of the version of the code. This version works with IDL 5.2. 
    … …  
    4344FUNCTION routine_name,  pilingnum 
    4445; 
    45 ; 
    4646  compile_opt idl2, strictarrsubs 
    4747; 

  • trunk/SRC/Utilities/testvar.pro

    r231 r242  
    22; 
    33; @file_comments 
    4 ; A kind of keyword_set but when the value exist, it send it back. 
     4; A kind of <proidl>keyword_set</proidl> but when the value exist, it  
     5; send it back. 
    56; 
    67; @categories 

  • trunk/SRC/Utilities/text_box.pro

    r231 r242  
    33; @file_comments 
    44; This procedure writes a short text message within a box-shaped 
    5 ; area in a graphics window. The message may be split at word 
     5; area in a graphic window. The message may be split at word 
    66; boundaries into several lines, and the character size and 
    77; orientation may be adjusted for the text to fit within the box. 
    88; 
    9 ; @param TEXT {in}{required} 
    10 ; ASCII text string containing the message. 
     9; @param TEXT {in}{required} {type=string} 
     10; message in ASCII. 
    1111; 
    1212; @keyword POS 
    13 ; 4 element vector specifying the box position and size 
    14 ; pos[0],pos[1] specify the lower left corner coordinate 
    15 ; pos[2],pos[3] specify the upper right corner coordinate 
    16 ; data window normalized coordinates are use 
     13; 4 elements vector specifying the box position and size 
     14; pos[0],pos[1] specify the lower left corner coordinate, 
     15; pos[2],pos[3] specify the upper right corner coordinate, 
     16; data window normalized coordinates are used. 
    1717; 
    1818; @keyword FG_COLOR {default=0} 
    … …  
    3939; 
    4040; @keyword BOX 
    41 ; activate to show the box on graphics window. 
     41; activate to show the box on graphic window. 
    4242; 
    4343; @history 
    … …  
    5353PRO text_box,text,pos=pos,fg_color=fg_color,bg_color=bg_color,$ 
    5454               center=center,right=right,box=box,vert_space=vert_space, _EXTRA = ex 
    55 ; 
    5655; 
    5756  compile_opt idl2, strictarrsubs 
    … …  
    182181return 
    183182end 
    184  

  • trunk/SRC/Utilities/undefine.pro

    r232 r242  
    33; @file_comments 
    44; erase a variable 
    5 ; same thing that delvar but usable in a program and usable 
     5; same thing like <proidl>delvar</proidl> but usable in a program and usable 
    66; for one variable simultaneously 
    77; 
    … …  
    2323; <a href="http://www.dfanning.com"/> : 
    2424;QUESTION: How do I make an IDL variable have a type "undefined"? 
    25 ;ANSWER: At the main IDL level you can use the IDL procedure DELVAR to 
     25;ANSWER: At the main IDL level you can use the IDL procedure <proidl>DELVAR</proidl> to 
    2626;delete an IDL variable and make it undefined. Inside of procedures 
    27 ;and functions, I use this little program named UNDEFINE that I got 
     27;and functions, I use this little program named <pro>UNDEFINE</pro> that I got 
    2828;from Andrew Cool at the DSTO High Frequency Radar Division in 
    2929;Adelaide, Australia. 

  • trunk/SRC/Utilities/xfile.pro

    r239 r242  
    22; 
    33; @file_comments 
    4 ; display in a widget an ASCII file. 
     4; display an ASCII file in a widget. 
    55; It is the same thing that <proidl>xdisplayfile<proidl> but here, we use it 
    66; to display the content of a procedure or of a function located in the !path 

  • trunk/SRC/Utilities/xhelp.pro

    r239 r242  
    77; Widget 
    88; 
    9 ; @param FILENAME {in}{required} 
    10 ; A scalar string that contains the filename of the file to display. 
    11 ; Filename should be located in !path. 
     9; @param FILENAME {in}{required} {type=scalar string} 
     10; the name of the file to display. 
     11; FILENAME should be located in !path. 
    1212; ".pro" suffix will be appended if needed. 
    1313; 
    … …  
    1616; 
    1717; @restrictions 
    18 ; Triggers the XMANAGER if it is not already in use. 
     18; Triggers the <proidl>XMANAGER</proidl> if it is not already in use. 
    1919; 
    2020; @examples 
Note: See TracChangeset for help on using the changeset viewer.