Changeset 231 for trunk/SRC/Utilities


Ignore:
Timestamp:
03/19/07 18:15:51 (17 years ago)
Author:
pinsard
Message:

improvements/corrections of some *.pro headers

Location:
trunk/SRC/Utilities
Files:
20 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Utilities/createfunc.pro

    r229 r231  
    1 ;------------------------------------------------------------ 
    2 ;------------------------------------------------------------ 
    3 ;------------------------------------------------------------ 
    41;+ 
     2; 
    53; @file_comments 
    64; write an IDL function, compile it and execute it. 
    … …  
    2119; 
    2220; @keyword _EXTRA  
    23 ; used to pass your keywords to the created function. 
     21; Used to pass keywords to the created function. 
    2422; 
    2523; @restrictions 
    … …  
    4038; 
    4139;- 
    42 ;------------------------------------------------------------ 
    43 ;------------------------------------------------------------ 
    44 ;------------------------------------------------------------ 
     40; 
    4541FUNCTION createfunc, command, FILENAMEIN = filenamein $ 
    4642               , KWDLIST = kwdlist, _EXTRA = ex 

  • trunk/SRC/Utilities/createpro.pro

    r230 r231  
    1 ;------------------------------------------------------------ 
    2 ;------------------------------------------------------------ 
    3 ;------------------------------------------------------------ 
    41;+ 
    52; @file_comments 
    … …  
    2421; 
    2522; @keyword _EXTRA  
    26 ; used to pass your keywords to the created procedure. 
     23; Used to pass keywords to the created procedure. 
    2724; 
    2825; @restrictions 
    … …  
    4643; $Id$ 
    4744;- 
    48 ;------------------------------------------------------------ 
    49 ;------------------------------------------------------------ 
    50 ;------------------------------------------------------------ 
     45; 
    5146PRO createpro, command, FILENAMEIN = filenamein $ 
    5247               , KWDLIST = kwdlist, KWDUSED = kwdused, _EXTRA = ex 
    … …  
    8883; compile it 
    8984   resolve_routine, shortfilename 
    90 help,ex,/structure 
    91 print,' ex = ',ex 
     85;help,ex,/structure 
     86;print,' ex = ',ex 
    9287; execute it 
    9388   call_procedure, shortfilename, _extra = ex 

  • trunk/SRC/Utilities/def_myuniquetmpdir.pro

    r224 r231  
    11;+ 
     2; 
    23; @file_comments 
    34; if needed, define and create myuniquetmpdir 
    … …  
    2122; 
    2223;- 
     24; 
    2325PRO def_myuniquetmpdir 
    2426; 

  • trunk/SRC/Utilities/demomode_compatibility.pro

    r224 r231  
    11;+ 
     2; 
    23; @categories 
    34; Utilities 
    … …  
    910; $Id$ 
    1011;- 
     12; 
    1113PRO demomode_compatibility 
    1214; 

  • trunk/SRC/Utilities/find.pro

    r224 r231  
    1 ;------------------------------------------------------------ 
    2 ;------------------------------------------------------------ 
    3 ;------------------------------------------------------------ 
    41;+ 
    52; @file_comments 
    … …  
    6562; 
    6663; @keyword _EXTRA  
    67 ; used to pass your keywords 
     64; Used to pass keywords 
    6865; 
    6966; @returns  
    … …  
    109106; $Id$ 
    110107;- 
    111 ;------------------------------------------------------------ 
    112 ;------------------------------------------------------------ 
    113 ;------------------------------------------------------------ 
     108; 
    114109FUNCTION find, filein, IODIRECTORY = iodirectory, RECURSIVE = recursive $ 
    115110               , REPERTOIRE = repertoire, NOPRO = nopro, ONLYPRO = onlypro $ 

  • trunk/SRC/Utilities/fitintobox.pro

    r224 r231  
    1  ;------------------------------------------------------------ 
    2 ;------------------------------------------------------------ 
    3 ;------------------------------------------------------------ 
    41;+ 
    52; 
    … …  
    4239; 
    4340;- 
    44 ;------------------------------------------------------------ 
    45 ;------------------------------------------------------------ 
    46 ;------------------------------------------------------------ 
     41; 
    4742FUNCTION err_mess, sz, jpi, nx, jpj, ny, jpk, nz, jpt 
    4843; 
    … …  
    7570; @param field {in}{required}{type=array or struct} 
    7671; an array or a structure that can be read by the function 
    77 ; litchamp.pro 
    78 ; 
    79 ; @param nx {in}{optional}{default=define by grille.pro} 
    80 ; 
    81 ; @param ny {in}{optional}{default=define by grille.pro} 
    82 ; 
    83 ; @param nz {in}{optional}{default=define by grille.pro} 
    84 ; 
    85 ; @param firstx {in}{optional}{default=define by grille.pro} 
    86 ; 
    87 ; @param firsty {in}{optional}{default=define by grille.pro} 
    88 ; 
    89 ; @param firstz {in}{optional}{default=define by grille.pro} 
    90 ; 
    91 ; @param lastx {in}{optional}{default=define by grille.pro} 
    92 ; 
    93 ; @param lasty {in}{optional}{default=define by grille.pro} 
    94 ; 
    95 ; @param lastz {in}{optional}{default=define by grille.pro} 
     72; <pro>litchamp</pro> 
     73; 
     74; @param nx {in}{optional}{default=define by <pro>grille</pro>} 
     75; 
     76; @param ny {in}{optional}{default=define by <pro>grille</pro>} 
     77; 
     78; @param nz {in}{optional}{default=define by <pro>grille</pro>} 
     79; 
     80; @param firstx {in}{optional}{default=define by <pro>grille</pro>} 
     81; 
     82; @param firsty {in}{optional}{default=define by <pro>grille</pro>} 
     83; 
     84; @param firstz {in}{optional}{default=define by <pro>grille</pro>} 
     85; 
     86; @param lastx {in}{optional}{default=define by <pro>grille</pro>} 
     87; 
     88; @param lasty {in}{optional}{default=define by <pro>grille</pro>} 
     89; 
     90; @param lastz {in}{optional}{default=define by <pro>grille</pro>} 
    9691; 
    9792; @keyword WDEPTH 
    … …  
    10297; or -1 if there is an error... 
    10398; 
    104 ; @uses cm_4mesh 
    105 ; @uses cm_4cal 
     99; @uses  
     100; cm_4mesh 
     101; cm_4cal 
    106102; 
    107103; @examples 
    … …  
    123119; $Id$ 
    124120;- 
    125 ;------------------------------------------------------------ 
     121; 
    126122FUNCTION fitintobox, field, nx, ny, nz, firstx, firsty $ 
    127123                     , firstz, lastx, lasty, lastz, WDEPTH = wdepth 
    128 ;------------------------------------------------------------ 
    129 ; include commons 
    130124; 
    131125  compile_opt idl2, strictarrsubs 

  • trunk/SRC/Utilities/isadirectory.pro

    r224 r231  
    1 ;------------------------------------------------------------ 
    2 ;------------------------------------------------------------ 
    3 ;------------------------------------------------------------ 
    41;+ 
     2; 
    53; @file_comments 
    64; check if a directory exists and make sure that it ends 
    … …  
    2220; 
    2321; @keyword _EXTRA 
    24 ; used to pass your keywords 
     22; Used to pass keywords 
    2523; 
    2624; all dialog_pickfile keywords (like filter) can be used. 
    … …  
    4543; $Id$ 
    4644;- 
    47 ;------------------------------------------------------------ 
    48 ;------------------------------------------------------------ 
    49 ;------------------------------------------------------------ 
     45; 
    5046FUNCTION isadirectory, directoryin, TITLE = title, IODIRECTORY = iodirectory, _extra = ex 
    5147; 

  • trunk/SRC/Utilities/isafile.pro

    r224 r231  
    1 ;------------------------------------------------------------ 
    2 ;------------------------------------------------------------ 
    3 ;------------------------------------------------------------ 
    41;+ 
     2; 
    53; @file_comments 
    6 ; same as find.pro except that as long as the file is 'NOT FOUND', 
     4; same as <pro>find</pro> except that as long as the file is 'NOT FOUND', 
    75; isafile calls dialog_pickfile, to ask the user to select a file. 
    86; 
    9 ; @categories io 
     7; @categories  
     8; io 
    109; 
    1110; @param FILEIN {in}{optional} 
    … …  
    3736; 
    3837; @keyword _EXTRA 
    39 ; used to pass your keywords 
     38; Used to pass keywords 
    4039; 
    4140; all find, file_search and dialog_pickfile keywords (like title) can be used 
    … …  
    6665; $Id$ 
    6766;- 
    68 ;------------------------------------------------------------ 
    69 ;------------------------------------------------------------ 
    70 ;------------------------------------------------------------ 
     67; 
    7168FUNCTION isafile, filein, FILENAME = filename, IODIRECTORY = iodirectory $ 
    7269                  , NEW = new, RECURSIVE = RECURSIVE, ONLYPRO = onlypro $ 
    7370                  , ONLYNC = onlync, _extra = ex 
    74 ;------------------------------------------------------------ 
    7571; 
    7672  compile_opt idl2, strictarrsubs 

  • trunk/SRC/Utilities/linearequation.pro

    r224 r231  
    1 ;------------------------------------------------------------ 
    2 ;------------------------------------------------------------ 
    3 ;------------------------------------------------------------ 
    41;+ 
    52; 
    … …  
    4340; 
    4441;- 
    45 ;------------------------------------------------------------ 
    46 ;------------------------------------------------------------ 
    47 ;------------------------------------------------------------ 
     42; 
    4843FUNCTION linearequation, point1, point2 
    4944; 

  • trunk/SRC/Utilities/lineintersection.pro

    r224 r231  
    1 ;------------------------------------------------------------ 
    2 ;------------------------------------------------------------ 
    3 ;------------------------------------------------------------ 
    41;+ 
    52; 
    … …  
    5754; 
    5855;- 
    59 ;------------------------------------------------------------ 
    60 ;------------------------------------------------------------ 
    61 ;------------------------------------------------------------ 
     56; 
    6257FUNCTION lineintersection, abc1, abc2, FLOAT = float 
    6358; 

  • trunk/SRC/Utilities/mergeonline_help.pro

    r224 r231  
    11;+ 
     2; 
    23; @file_comments 
    34; Have one unique online help for IDL and SAXO 
    … …  
    1516; $Id$ 
    1617;- 
     18; 
    1719PRO mergeonline_help 
    1820; 

  • trunk/SRC/Utilities/protype.pro

    r224 r231  
    1 ;------------------------------------------------------------ 
    2 ;------------------------------------------------------------ 
    3 ;------------------------------------------------------------ 
    41;+ 
     2; 
    53; @file_comments 
    64; test is a ".pro" file corresponds to an IDL procedure, function or batch file. 
    … …  
    3634; $Id$ 
    3735;- 
    38 ;------------------------------------------------------------ 
    39 ;------------------------------------------------------------ 
    40 ;------------------------------------------------------------ 
     36; 
    4137FUNCTION protype, file 
    4238; 

  • trunk/SRC/Utilities/pwd.pro

    r224 r231  
    1 ;------------------------------------------------------------ 
    2 ;------------------------------------------------------------ 
    3 ;------------------------------------------------------------ 
    41;+ 
    52; 
    … …  
    1714; 
    1815;- 
    19 ;------------------------------------------------------------ 
    20 ;------------------------------------------------------------ 
    21 ;------------------------------------------------------------ 
     16; 
    2217PRO pwd 
    2318; 

  • trunk/SRC/Utilities/report.pro

    r230 r231  
    1 ;------------------------------------------------------------ 
    2 ;------------------------------------------------------------ 
    3 ;------------------------------------------------------------ 
    41;+ 
    52; 
    63; @file_comments 
    7 ; Like dialog_message.pro if there is already some widget 
    8 ; active or like message.pro if there is not any widget active. 
     4; Like <pro>dialog_message</pro> if there is already some widget 
     5; active or like <pro>message</pro> if there is not any widget active. 
    96; To ask a question whose answer is not yes/no,use xquestion. 
    107; 
    … …  
    2017; 
    2118; @keyword _EXTRA 
    22 ; used to pass keywords from dialog_message.pro and message.pro 
     19; Used to pass keywords to <pro>dialog_message</pro> and <pro>message</pro> 
    2320; 
    2421; @keyword PARENT 
    25 ; same as DIALOG_PARENT de dialog_message.pro 
     22; same as DIALOG_PARENT of <pro>dialog_message</pro> 
    2623; 
    2724; @keyword QUESTION {default="Warning"} 
    … …  
    6461; 
    6562;- 
    66 ;------------------------------------------------------------ 
    67 ;------------------------------------------------------------ 
    68 ;------------------------------------------------------------ 
     63; 
    6964FUNCTION report, text, DEFAULT_NO = default_no, PARENT = parent, QUESTION = question, SIMPLE = simple, _extra = ex 
    7065; 

  • trunk/SRC/Utilities/routine_name.pro

    r226 r231  
    1 ;------------------------------------------------------------ 
    2 ;------------------------------------------------------------ 
    3 ;------------------------------------------------------------ 
    41;+ 
    52; 
    … …  
    4340; 
    4441;- 
    45 ;------------------------------------------------------------ 
    46 ;------------------------------------------------------------ 
    47 ;------------------------------------------------------------ 
     42; 
    4843FUNCTION routine_name,  pilingnum 
    4944; 

  • trunk/SRC/Utilities/testvar.pro

    r224 r231  
    1 ;------------------------------------------------------------ 
    2 ;------------------------------------------------------------ 
    3 ;------------------------------------------------------------ 
    41;+ 
    52; 
    … …  
    3027; 
    3128;- 
    32 ;------------------------------------------------------------ 
    33 ;------------------------------------------------------------ 
    34 ;------------------------------------------------------------ 
     29; 
    3530FUNCTION testvar, var = var 
    3631; 

  • trunk/SRC/Utilities/text_box.pro

    r226 r231  
    3636; 
    3737; @keyword _EXTRA 
    38 ; used to pass your keyword 
     38; Used to pass keywords 
    3939; 
    4040; @keyword BOX 
    … …  
    5050; 
    5151;- 
     52; 
    5253PRO text_box,text,pos=pos,fg_color=fg_color,bg_color=bg_color,$ 
    5354               center=center,right=right,box=box,vert_space=vert_space, _EXTRA = ex 

  • trunk/SRC/Utilities/undefine.pro

    r224 r231  
    1 ;------------------------------------------------------------ 
    2 ;------------------------------------------------------------ 
    3 ;------------------------------------------------------------ 
    41;+ 
    52; 
    … …  
    3633; 
    3734;- 
    38 ;------------------------------------------------------------ 
    39 ;------------------------------------------------------------ 
    40 ;------------------------------------------------------------ 
    41    PRO undefine, varname 
     35; 
     36PRO undefine, varname 
    4237; 
    4338  compile_opt idl2, strictarrsubs 
    … …  
    4540   tempvar = SIZE(TEMPORARY(varname)) 
    4641   END 
    47  

  • trunk/SRC/Utilities/xfile.pro

    r230 r231  
    1 ;------------------------------------------------------------ 
    2 ;------------------------------------------------------------ 
    3 ;------------------------------------------------------------ 
    41;+ 
    52; 
    … …  
    1815; 
    1916; @keyword _EXTRA 
    20 ; used to pass your keywords 
     17; Used to pass keywords 
    2118; 
    2219; @examples 
    … …  
    3229; 
    3330;- 
    34 ;------------------------------------------------------------ 
    35 ;------------------------------------------------------------ 
    36 ;------------------------------------------------------------ 
     31; 
    3732PRO xfile, filename, _extra = ex 
    3833; 

  • trunk/SRC/Utilities/xhelp.pro

    r230 r231  
    1515; 
    1616; @keyword _EXTRA 
    17 ; used to pass your keywords 
     17; Used to pass keywords 
    1818; 
    1919; @restrictions 
    … …  
    3838; 
    3939;- 
     40; 
    4041PRO xhelp, filename, _extra=ex 
    4142; 
Note: See TracChangeset for help on using the changeset viewer.