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/Documentation/idldoc_html_output/Utilities
Files:
19 edited

Legend:

Unmodified
Added
Removed

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

    r157 r163  
    834834           
    835835         
     836          <h3>Statistics</h3> 
     837          <table class="statistics"> 
     838            <tr><td>McCabe cyclic</td><td>           6</td></tr> 
     839            <tr><td>McCabe essential</td><td>           1</td></tr> 
     840            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     841          </table> 
    836842           
    837843         

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

    r157 r163  
    735735              <span class="attr">required</span> 
    736736               
    737                
     737              <span class="attr">type:</span> <span class="value">string array</span> 
    738738               
    739739               
    740740            </h4> 
    741741         
    742           <div class="comments">  
     742          <div class="comments"> 
    743743 a string array defining the procedure to be created.  
    744744 each element will be a line of the created procedure. 
    … …  
    852852           
    853853         
     854          <h3>Statistics</h3> 
     855          <table class="statistics"> 
     856            <tr><td>McCabe cyclic</td><td>           6</td></tr> 
     857            <tr><td>McCabe essential</td><td>           1</td></tr> 
     858            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     859          </table> 
    854860           
    855861         

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

    r157 r163  
    737737          <h3>Version history</h3> 
    738738           
    739           <h4>Version</h4><div class="preformat"> $Id: def_myuniquetmpdir.pro 128 2006-07-06 14:32:02Z pinsard $ 
     739          <h4>Version</h4><div class="preformat"> $Id: def_myuniquetmpdir.pro 157 2006-08-21 09:01:50Z navarro $ 
    740740</div> 
    741741          <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
    … …  
    759759           
    760760         
     761          <h3>Statistics</h3> 
     762          <table class="statistics"> 
     763            <tr><td>McCabe cyclic</td><td>           3</td></tr> 
     764            <tr><td>McCabe essential</td><td>           1</td></tr> 
     765            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     766          </table> 
    761767           
    762768         

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

    r157 r163  
    730730          <h3>Version history</h3> 
    731731           
    732           <h4>Version</h4><div class="preformat"> $Id: demomode_compatibility.pro 128 2006-07-06 14:32:02Z pinsard $</div> 
     732          <h4>Version</h4><div class="preformat"> $Id: demomode_compatibility.pro 157 2006-08-21 09:01:50Z navarro $</div> 
    733733           
    734734           
    … …  
    748748           
    749749         
     750          <h3>Statistics</h3> 
     751          <table class="statistics"> 
     752            <tr><td>McCabe cyclic</td><td>           4</td></tr> 
     753            <tr><td>McCabe essential</td><td>           1</td></tr> 
     754            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     755          </table> 
    750756           
    751757         

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

    r157 r163  
    997997           
    998998         
     999          <h3>Statistics</h3> 
     1000          <table class="statistics"> 
     1001            <tr><td>McCabe cyclic</td><td>          23</td></tr> 
     1002            <tr><td>McCabe essential</td><td>           1</td></tr> 
     1003            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     1004          </table> 
    9991005           
    10001006         

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

    r157 r163  
    743743              <span class="attr">required</span> 
    744744               
    745                
    746                
    747                
    748             </h4> 
    749          
    750           <div class="comments"> an array or a structure that can be read by the function                 
    751      litchamp.pro 
     745              <span class="attr">type:</span> <span class="value">array or struct</span> 
     746               
     747               
     748            </h4> 
     749         
     750          <div class="comments"> 
     751 an array or a structure that can be read by the function                 
     752 litchamp.pro 
    752753 </div> 
    753754             
    … …  
    914915          <h3>Version history</h3> 
    915916           
    916           <h4>Version</h4><div class="preformat"> $Id: fitintobox.pro 136 2006-07-10 15:20:19Z pinsard $</div> 
     917          <h4>Version</h4><div class="preformat"> $Id: fitintobox.pro 157 2006-08-21 09:01:50Z navarro $</div> 
    917918          <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
    918919          10 juin 2000. 
    … …  
    937938           
    938939         
     940          <h3>Statistics</h3> 
     941          <table class="statistics"> 
     942            <tr><td>McCabe cyclic</td><td>          66</td></tr> 
     943            <tr><td>McCabe essential</td><td>           1</td></tr> 
     944            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     945          </table> 
    939946           
    940947         

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

    r157 r163  
    838838           
    839839         
     840          <h3>Statistics</h3> 
     841          <table class="statistics"> 
     842            <tr><td>McCabe cyclic</td><td>          10</td></tr> 
     843            <tr><td>McCabe essential</td><td>           1</td></tr> 
     844            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     845          </table> 
    840846           
    841847         

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

    r157 r163  
    908908           
    909909         
     910          <h3>Statistics</h3> 
     911          <table class="statistics"> 
     912            <tr><td>McCabe cyclic</td><td>          13</td></tr> 
     913            <tr><td>McCabe essential</td><td>           1</td></tr> 
     914            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     915          </table> 
    910916           
    911917         

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

    r157 r163  
    787787          <h3>Version history</h3> 
    788788           
    789           <h4>Version</h4><div class="preformat"> $Id: linearequation.pro 136 2006-07-10 15:20:19Z pinsard $ 
     789          <h4>Version</h4><div class="preformat"> $Id: linearequation.pro 157 2006-08-21 09:01:50Z navarro $ 
    790790</div> 
    791791          <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
    … …  
    808808           
    809809         
     810          <h3>Statistics</h3> 
     811          <table class="statistics"> 
     812            <tr><td>McCabe cyclic</td><td>           5</td></tr> 
     813            <tr><td>McCabe essential</td><td>           1</td></tr> 
     814            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     815          </table> 
    810816           
    811817         

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

    r157 r163  
    731731      1) by default: it is a vector of complex whose each element is the coordinates  
    732732                     of the intersection point of a pair of straight lines. 
    733       2) if FLOAT is activated, it is a table of reals of dimension 2,  
     733      2) if FLOAT is activated, it is a array of reels of dimension 2,  
    734734         number_of_pairs_of_straight_lines whose each row is the coordinates  
    735735         of the intersection point of a pair of straight line. 
    … …  
    746746              <span class="attr">required</span> 
    747747               
    748                
     748              <span class="attr">type:</span> <span class="value">3d array</span> 
    749749               
    750750               
    751751            </h4> 
    752752         
    753           <div class="comments">  
    754  is the first table of dimension 3, number_of_pairs_of_straight_lines,  
     753          <div class="comments"> 
     754 is the first array of dimension 3, number_of_pairs_of_straight_lines,  
    755755 whose each line contain the 3 parameters a,b and c of the first linear  
    756756 equation of the type ax+by+c=0 
    … …  
    763763              <span class="attr">required</span> 
    764764               
    765                
     765              <span class="attr">type:</span> <span class="value">3d array</span> 
    766766               
    767767               
    768768            </h4> 
    769769         
    770           <div class="comments">  
    771  is second table of dimension 3, number_of_pairs_of_straight_lines,  
     770          <div class="comments"> 
     771 is second array of dimension 3, number_of_pairs_of_straight_lines,  
    772772 whose each line contain the 3 parameters a,b and c of the second linear  
    773773 equation of the type ax+by+c=0 
    … …  
    793793         
    794794            <div class="comments">  
    795  To return the output as a table of real numbers instead of vectors of  
     795 To return the output as a array of real numbers instead of vectors of  
    796796 complex (by default) 
    797797</div> 
    … …  
    809809          <h3>Version history</h3> 
    810810           
    811           <h4>Version</h4><div class="preformat"> $Id: lineintersection.pro 136 2006-07-10 15:20:19Z pinsard $ 
     811          <h4>Version</h4><div class="preformat"> $Id: lineintersection.pro 157 2006-08-21 09:01:50Z navarro $ 
    812812</div> 
    813813          <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
    … …  
    838838           
    839839         
     840          <h3>Statistics</h3> 
     841          <table class="statistics"> 
     842            <tr><td>McCabe cyclic</td><td>           3</td></tr> 
     843            <tr><td>McCabe essential</td><td>           1</td></tr> 
     844            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     845          </table> 
    840846           
    841847         

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

    r157 r163  
    768768          <h3>Version history</h3> 
    769769           
    770           <h4>Version</h4><div class="preformat"> $Id: protype.pro 136 2006-07-10 15:20:19Z pinsard $</div> 
     770          <h4>Version</h4><div class="preformat"> $Id: protype.pro 157 2006-08-21 09:01:50Z navarro $</div> 
    771771          <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
    772772                       Feb 2006 
    … …  
    788788           
    789789         
     790          <h3>Statistics</h3> 
     791          <table class="statistics"> 
     792            <tr><td>McCabe cyclic</td><td>           5</td></tr> 
     793            <tr><td>McCabe essential</td><td>           1</td></tr> 
     794            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     795          </table> 
    790796           
    791797         

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

    r157 r163  
    754754           
    755755         
     756          <h3>Statistics</h3> 
     757          <table class="statistics"> 
     758            <tr><td>McCabe cyclic</td><td>           1</td></tr> 
     759            <tr><td>McCabe essential</td><td>           1</td></tr> 
     760            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     761          </table> 
    756762           
    757763         

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

    r157 r163  
    882882           
    883883         
     884          <h3>Statistics</h3> 
     885          <table class="statistics"> 
     886            <tr><td>McCabe cyclic</td><td>          15</td></tr> 
     887            <tr><td>McCabe essential</td><td>           1</td></tr> 
     888            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     889          </table> 
    884890           
    885891         

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

    r157 r163  
    749749 A whole number which give us how many level we have to reascend 
    750750 in the piling up of routines and subroutines to find the looked for routine. 
    751  
    752751</div> 
    753752             
    … …  
    771770          <h3>Version history</h3> 
    772771           
    773           <h4>Version</h4><div class="preformat"> $Id: routine_name.pro 136 2006-07-10 15:20:19Z pinsard $ 
     772          <h4>Version</h4><div class="preformat"> $Id: routine_name.pro 157 2006-08-21 09:01:50Z navarro $ 
    774773</div> 
    775774          <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
    … …  
    784783          <h4>Restrictions</h4><div class="preformat"> 
    785784 This function use the keyword OUTPUT in help.pro and it is specified 
    786  in the online help that the return syntax of this word can change in 
     785 in the on-line help that the return syntax of this word can change in 
    787786 function of the version of the code. This version works with IDL 5.2. 
    788787</div> 
    … …  
    796795           
    797796         
     797          <h3>Statistics</h3> 
     798          <table class="statistics"> 
     799            <tr><td>McCabe cyclic</td><td>           6</td></tr> 
     800            <tr><td>McCabe essential</td><td>           1</td></tr> 
     801            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     802          </table> 
    798803           
    799804         

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

    r157 r163  
    761761          <h3>Version history</h3> 
    762762           
    763           <h4>Version</h4><div class="preformat"> $Id: testvar.pro 136 2006-07-10 15:20:19Z pinsard $ 
     763          <h4>Version</h4><div class="preformat"> $Id: testvar.pro 157 2006-08-21 09:01:50Z navarro $ 
    764764</div> 
    765765          <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
    … …  
    782782           
    783783         
     784          <h3>Statistics</h3> 
     785          <table class="statistics"> 
     786            <tr><td>McCabe cyclic</td><td>           2</td></tr> 
     787            <tr><td>McCabe essential</td><td>           1</td></tr> 
     788            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     789          </table> 
    784790           
    785791         

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

    r157 r163  
    780780               
    781781               
    782                
     782              <span class="attr">default:</span> <span class="value">0</span> 
    783783               
    784784            </h4> 
    785785         
    786786            <div class="comments"> 
    787  color of box and legend titles (default=0) 
     787 color of box and legend titles 
    788788</div> 
    789789             
    … …  
    909909           
    910910         
     911          <h3>Statistics</h3> 
     912          <table class="statistics"> 
     913            <tr><td>McCabe cyclic</td><td>          22</td></tr> 
     914            <tr><td>McCabe essential</td><td>           1</td></tr> 
     915            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     916          </table> 
    911917           
    912918         

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

    r157 r163  
    716716         
    717717 
    718         <div class="routine_details" id="_UNDEFINE"> 
    719  
    720           <h2><a class="top" href="#container">top</a>UNDEFINE <span class="categories">  
     718        <div class="routine_details" id="_undefine"> 
     719 
     720          <h2><a class="top" href="#container">top</a>undefine <span class="categories">  
    721721 Utilities   
    722722 </span></h2> 
    723723         
    724724          <p class="header"> 
    725             UNDEFINE<span class="result">, <a href="#_UNDEFINE_param_varname">varname</a></span></p> 
     725            undefine<span class="result">, <a href="#_undefine_param_varname">varname</a></span></p> 
    726726         
    727727          <div class="comments"> 
    … …  
    734734         
    735735             
    736             <h4 id="_UNDEFINE_param_varname">varname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     736            <h4 id="_undefine_param_varname">varname&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    737737              <span class="attr">in</span> 
    738738               
    … …  
    763763          <h3>Version history</h3> 
    764764           
    765           <h4>Version</h4><div class="preformat"> $Id: undefine.pro 136 2006-07-10 15:20:19Z pinsard $ 
     765          <h4>Version</h4><div class="preformat"> $Id: undefine.pro 157 2006-08-21 09:01:50Z navarro $ 
    766766</div> 
    767767          <h4>History</h4><div class="preformat"> trouve sur la page web de D.Fanning  
    … …  
    790790           
    791791         
     792          <h3>Statistics</h3> 
     793          <table class="statistics"> 
     794            <tr><td>McCabe cyclic</td><td>           1</td></tr> 
     795            <tr><td>McCabe essential</td><td>           1</td></tr> 
     796            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     797          </table> 
    792798           
    793799         

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

    r157 r163  
    779779          <h3>Version history</h3> 
    780780           
    781           <h4>Version</h4><div class="preformat"> $Id: xfile.pro 136 2006-07-10 15:20:19Z pinsard $ 
     781          <h4>Version</h4><div class="preformat"> $Id: xfile.pro 157 2006-08-21 09:01:50Z navarro $ 
    782782</div> 
    783783          <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
    … …  
    801801           
    802802         
     803          <h3>Statistics</h3> 
     804          <table class="statistics"> 
     805            <tr><td>McCabe cyclic</td><td>          10</td></tr> 
     806            <tr><td>McCabe essential</td><td>           1</td></tr> 
     807            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     808          </table> 
    803809           
    804810         

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

    r157 r163  
    780780          <h3>Version history</h3> 
    781781           
    782           <h4>Version</h4><div class="preformat"> $Id: xhelp.pro 141 2006-07-21 09:17:25Z theetten $ 
     782          <h4>Version</h4><div class="preformat"> $Id: xhelp.pro 157 2006-08-21 09:01:50Z navarro $ 
    783783</div> 
    784784          <h4>History</h4><div class="preformat"> Written By Steve Richards, December 1990 
    … …  
    810810           
    811811         
     812          <h3>Statistics</h3> 
     813          <table class="statistics"> 
     814            <tr><td>McCabe cyclic</td><td>          16</td></tr> 
     815            <tr><td>McCabe essential</td><td>           1</td></tr> 
     816            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     817          </table> 
    812818           
    813819         
Note: See TracChangeset for help on using the changeset viewer.