Ignore:
Timestamp:
06/09/06 17:18:59 (18 years ago)
Author:
pinsard
Message:

start to modify headers of Obsolete *.pro files for better idldoc output

Location:
trunk/SRC/Documentation/idldoc_html_output/Utilities
Files:
9 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Documentation/idldoc_html_output/Utilities/createfunc.html

    r93 r97  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
     89      <div id="file_comments"> write an idl function, compile it and execute it. 
     90 usefull to avoid the use of execute 
     91</div> 
    9092 
    9193       
    … …  
    107109            <span class="result">result = </span>createfunc(<span class="result"><a href="#_createfunc_param_command">command</a></span>, <a href="#_createfunc_keyword_FILENAMEIN">FILENAMEIN</a>=<span class="result">FILENAMEIN</span>, <a href="#_createfunc_keyword_KWDLIST">KWDLIST</a>=<span class="result">KWDLIST</span>, <a href="#_createfunc_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p> 
    108110         
    109           <div class="comments"> 
    110  write an idl function, compile it and execute it. 
    111  usefull to avoid the use of execute 
    112 </div> 
     111          <div class="comments"></div> 
    113112 
    114113           

  • trunk/SRC/Documentation/idldoc_html_output/Utilities/createpro.html

    r93 r97  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
     89      <div id="file_comments"> write an idl procedure, compile it and execute it. 
     90</div> 
    9091 
    9192       
    … …  
    107108            createpro<span class="result">, <a href="#_createpro_param_command">command</a></span>, <a href="#_createpro_keyword_FILENAMEIN">FILENAMEIN</a>=<span class="result">FILENAMEIN</span>, <a href="#_createpro_keyword_KWDLIST">KWDLIST</a>=<span class="result">KWDLIST</span>, <a href="#_createpro_keyword_KWDUSED">KWDUSED</a>=<span class="result">KWDUSED</span>, <a href="#_createpro_keyword__extra">_extra</a>=<span class="result">_extra</span></p> 
    108109         
    109           <div class="comments"> 
    110  write an idl procedure, compile it and execute it. 
    111 </div> 
     110          <div class="comments"></div> 
    112111 
    113112           

  • trunk/SRC/Documentation/idldoc_html_output/Utilities/def_myuniquetmpdir.html

    r93 r97  
    8787      </div> 
    8888 
    89       <div id="file_comments"> SIDE EFFECTS: see purpose 
     89      <div id="file_comments"> if needed, define and create myuniquetmpdir 
     90 (common variable from cm_general) and add it to !path 
    9091</div> 
    9192 
    … …  
    109110            def_myuniquetmpdir</p> 
    110111         
    111           <div class="comments"> 
    112  if needed, define and create myuniquetmpdir 
    113  (common variable from cm_general) and add it to !path 
    114 </div> 
     112          <div class="comments"></div> 
    115113 
    116114           

  • trunk/SRC/Documentation/idldoc_html_output/Utilities/demomode_compatibility.html

    r93 r97  
    128128           
    129129         
     130          <h3>Other attributes</h3> 
    130131           
    131132           
    132            
    133            
     133          <h4>Uses routines</h4><div class="value"> cm_general</div> 
    134134           
    135135           

  • trunk/SRC/Documentation/idldoc_html_output/Utilities/directory-overview.html

    r93 r97  
    9090       
    9191        <dt><a href="createfunc.html?format=raw">createfunc.pro</a></dt> 
    92         <dd></dd> 
     92        <dd> write an idl function, compile it and execute it.</dd> 
    9393       
    9494        <dt><a href="createpro.html?format=raw">createpro.pro</a></dt> 
    95         <dd></dd> 
     95        <dd> write an idl procedure, compile it and execute it.</dd> 
    9696       
    9797        <dt><a href="def_myuniquetmpdir.html?format=raw">def_myuniquetmpdir.pro</a></dt> 
    98         <dd> SIDE EFFECTS: see purpose </dd> 
     98        <dd> if needed, define and create myuniquetmpdir  (common variable from cm_general) and add it to !path </dd> 
    9999       
    100100        <dt><a href="demomode_compatibility.html?format=raw">demomode_compatibility.pro</a></dt> 
    … …  
    102102       
    103103        <dt><a href="find.html?format=raw">find.pro</a></dt> 
    104         <dd>  all file_search keywords can be used.</dd> 
     104        <dd> based on file_search, but it is possible to speficy           a set of possibles names and a different set of           possibles directories names.</dd> 
    105105       
    106106        <dt><a href="isadirectory.html?format=raw">isadirectory.pro</a></dt> 
    107         <dd>  all dialog_pickfile keywords (like filter) can be used.</dd> 
     107        <dd> check if a directory exists and make sure that it ends           with the directory separator mark.</dd> 
    108108       
    109109        <dt><a href="isafile.html?format=raw">isafile.pro</a></dt> 
    110         <dd> all find, file_search and dialog_pickfile keywords (like title) can be used </dd> 
     110        <dd> same as find.</dd> 
    111111       
    112112        <dt><a href="protype.html?format=raw">protype.pro</a></dt> 
    113         <dd></dd> 
     113        <dd> test is a ".</dd> 
    114114       
    115115      </dl> 

  • trunk/SRC/Documentation/idldoc_html_output/Utilities/find.html

    r93 r97  
    8787      </div> 
    8888 
    89       <div id="file_comments">  all file_search keywords can be used. 
    90 </div> 
    91  
    92        
    93  
    94        
    95  
    96        
    97  
    98        
    99  
    100       <div id="routine_details"> 
    101          
    102  
    103         <div class="routine_details" id="_find"> 
    104  
    105           <h2><a class="top" href="#container">top</a>find <span class="categories"> find a file 
    106 </span></h2> 
    107          
    108           <p class="header"> 
    109             <span class="result">result = </span>find(<span class="result"><a href="#_find_param_filein">filein</a></span>, <a href="#_find_keyword_IODIRECTORY">IODIRECTORY</a>=<span class="result">IODIRECTORY</span>, <a href="#_find_keyword_RECURSIVE">RECURSIVE</a>=<span class="result">RECURSIVE</span>, <a href="#_find_keyword_REPERTOIRE">REPERTOIRE</a>=<span class="result">REPERTOIRE</span>, <a href="#_find_keyword_NOPRO">NOPRO</a>=<span class="result">NOPRO</span>, <a href="#_find_keyword_ONLYPRO">ONLYPRO</a>=<span class="result">ONLYPRO</span>, <a href="#_find_keyword_ONLYNC">ONLYNC</a>=<span class="result">ONLYNC</span>, <a href="#_find_keyword_UNIQUE">UNIQUE</a>=<span class="result">UNIQUE</span>, <a href="#_find_keyword_FIRSTFOUND">FIRSTFOUND</a>=<span class="result">FIRSTFOUND</span>, <a href="#_find_keyword_LOOKALLDIR">LOOKALLDIR</a>=<span class="result">LOOKALLDIR</span>, <a href="#_find_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p> 
    110          
    111           <div class="comments"> 
    112  based on file_search, but it is possible to speficy 
     89      <div id="file_comments"> based on file_search, but it is possible to speficy 
    11390          a set of possibles names and a different set of 
    11491          possibles directories names. 
    11592          By defaut look for files included in !path 
    116 </div> 
     93 
     94 all file_search keywords can be used. 
     95</div> 
     96 
     97       
     98 
     99       
     100 
     101       
     102 
     103       
     104 
     105      <div id="routine_details"> 
     106         
     107 
     108        <div class="routine_details" id="_find"> 
     109 
     110          <h2><a class="top" href="#container">top</a>find <span class="categories"> find a file 
     111</span></h2> 
     112         
     113          <p class="header"> 
     114            <span class="result">result = </span>find(<span class="result"><a href="#_find_param_filein">filein</a></span>, <a href="#_find_keyword_IODIRECTORY">IODIRECTORY</a>=<span class="result">IODIRECTORY</span>, <a href="#_find_keyword_RECURSIVE">RECURSIVE</a>=<span class="result">RECURSIVE</span>, <a href="#_find_keyword_REPERTOIRE">REPERTOIRE</a>=<span class="result">REPERTOIRE</span>, <a href="#_find_keyword_NOPRO">NOPRO</a>=<span class="result">NOPRO</span>, <a href="#_find_keyword_ONLYPRO">ONLYPRO</a>=<span class="result">ONLYPRO</span>, <a href="#_find_keyword_ONLYNC">ONLYNC</a>=<span class="result">ONLYNC</span>, <a href="#_find_keyword_UNIQUE">UNIQUE</a>=<span class="result">UNIQUE</span>, <a href="#_find_keyword_FIRSTFOUND">FIRSTFOUND</a>=<span class="result">FIRSTFOUND</span>, <a href="#_find_keyword_LOOKALLDIR">LOOKALLDIR</a>=<span class="result">LOOKALLDIR</span>, <a href="#_find_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p> 
     115         
     116          <div class="comments"></div> 
    117117 
    118118          <h3>Return value</h3><div class="value"> A scalar or array variable of string type, containing the 

  • trunk/SRC/Documentation/idldoc_html_output/Utilities/isadirectory.html

    r93 r97  
    8787      </div> 
    8888 
    89       <div id="file_comments">  all dialog_pickfile keywords (like filter) can be used. 
     89      <div id="file_comments"> check if a directory exists and make sure that it ends  
     90         with the directory separator mark. 
     91 
     92 all dialog_pickfile keywords (like filter) can be used. 
    9093</div> 
    9194 
    … …  
    109112            <span class="result">result = </span>isadirectory(<span class="result">[<a href="#_isadirectory_param_directoryin">directoryin</a>]</span>, <a href="#_isadirectory_keyword_TITLE">TITLE</a>=<span class="result">TITLE</span>, <a href="#_isadirectory_keyword_IODIRECTORY">IODIRECTORY</a>=<span class="result">IODIRECTORY</span>, <a href="#_isadirectory_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p> 
    110113         
    111           <div class="comments"> 
    112  check if a directory exists and make sure that it ends  
    113          with the directory separator mark. 
    114 </div> 
     114          <div class="comments"></div> 
    115115 
    116116          <h3>Return value</h3><div class="value"> the directory name 

  • trunk/SRC/Documentation/idldoc_html_output/Utilities/isafile.html

    r93 r97  
    8787      </div> 
    8888 
    89       <div id="file_comments"> all find, file_search and dialog_pickfile keywords (like title) 
    90 can be used 
     89      <div id="file_comments"> same as find.pro except that as long as the file is 'NOT FOUND', 
     90          isafile calls dialog_pickfile, to ask the user to select a file. 
     91 
     92 all find, file_search and dialog_pickfile keywords (like title) can be used 
    9193</div> 
    9294 
    … …  
    111113            <span class="result">result = </span>isafile(<span class="result">[<a href="#_isafile_param_filein">filein</a>]</span>, <a href="#_isafile_keyword_FILENAME">FILENAME</a>=<span class="result">FILENAME</span>, <a href="#_isafile_keyword_IODIRECTORY">IODIRECTORY</a>=<span class="result">IODIRECTORY</span>, <a href="#_isafile_keyword_NEW">NEW</a>=<span class="result">NEW</span>, <a href="#_isafile_keyword_RECURSIVE">RECURSIVE</a>=<span class="result">RECURSIVE</span>, <a href="#_isafile_keyword_ONLYPRO">ONLYPRO</a>=<span class="result">ONLYPRO</span>, <a href="#_isafile_keyword_ONLYNC">ONLYNC</a>=<span class="result">ONLYNC</span>, <a href="#_isafile_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p> 
    112114         
    113           <div class="comments"> 
    114  same as find.pro except that as long as the file is 'NOT FOUND', 
    115           isafile calls dialog_pickfile, to ask the user to select a file. 
    116 </div> 
     115          <div class="comments"></div> 
    117116 
    118117          <h3>Return value</h3><div class="value"> the filename with its path 

  • trunk/SRC/Documentation/idldoc_html_output/Utilities/protype.html

    r93 r97  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
     89      <div id="file_comments"> test is a ".pro" file corresponds to an IDL procedure, 
     90          function or batch file. 
     91</div> 
    9092 
    9193       
    … …  
    108110            <span class="result">result = </span>protype(<span class="result"><a href="#_protype_param_file">file</a></span>)</p> 
    109111         
    110           <div class="comments"> 
    111  test is a ".pro" file corresponds to an IDL procedure, 
    112           function or batch file. 
    113 </div> 
     112          <div class="comments"></div> 
    114113 
    115114          <h3>Return value</h3><div class="value"> A scalar of string type: 'proc', 'func' or 'batch' 
Note: See TracChangeset for help on using the changeset viewer.