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)

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRING/str_size.html

    r157 r163  
    701701      <div id="file_comments"> 
    702702 The purpose of this function is to return the proper 
    703  character size to make a specified string a specifed 
     703 character size to make a specified string a specified 
    704704 width in a window. The width is specified in normalized 
    705705 coordinates. The function is extremely useful for sizing 
    … …  
    718718         
    719719 
    720         <div class="routine_details" id="_STR_SIZE"> 
    721  
    722           <h2><a class="top" href="#container">top</a>STR_SIZE <span class="categories"> 
     720        <div class="routine_details" id="_str_size"> 
     721 
     722          <h2><a class="top" href="#container">top</a>str_size <span class="categories"> 
    723723 Graphics, Widget 
    724724</span></h2> 
    725725         
    726726          <p class="header"> 
    727             <span class="result">result = </span>STR_SIZE(<span class="result"><a href="#_STR_SIZE_param_string">string</a>[, <a href="#_STR_SIZE_param_targetWidth">targetWidth</a>]</span>, <a href="#_STR_SIZE_keyword_INITSIZE">INITSIZE</a>=<span class="result">INITSIZE</span>, <a href="#_STR_SIZE_keyword_STEP">STEP</a>=<span class="result">STEP</span>)</p> 
     727            <span class="result">result = </span>str_size(<span class="result"><a href="#_str_size_param_string">string</a>[, <a href="#_str_size_param_targetWidth">targetWidth</a>]</span>, <a href="#_str_size_keyword_INITSIZE">INITSIZE</a>=<span class="result">INITSIZE</span>, <a href="#_str_size_keyword_STEP">STEP</a>=<span class="result">STEP</span>)</p> 
    728728         
    729729          <div class="comments"> 
    … …  
    741741         
    742742             
    743             <h4 id="_STR_SIZE_param_string">string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     743            <h4 id="_str_size_param_string">string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    744744              <span class="attr">in</span> 
    745745               
    … …  
    753753         
    754754          <div class="comments"> 
    755  This is the string that you want to make a specifed 
     755 This is the string that you want to make a specified 
    756756 target size or width. 
    757757</div> 
    758758             
    759             <h4 id="_STR_SIZE_param_targetWidth">targetWidth&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     759            <h4 id="_str_size_param_targetWidth">targetWidth&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    760760              <span class="attr">in</span> 
    761761               
    … …  
    764764               
    765765               
    766                
     766              <span class="attr">default:</span> <span class="value">0.25</span> 
    767767               
    768768            </h4> 
    … …  
    773773 size of the string (returned as thisCharSize) will be 
    774774 calculated to get the string width as close as possible to 
    775  the target width. The default is 0.25. 
     775 the target width. 
    776776</div> 
    777777             
    … …  
    783783            <h3>Keywords</h3> 
    784784             
    785             <h4 id="_STR_SIZE_keyword_INITSIZE">INITSIZE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     785            <h4 id="_str_size_keyword_INITSIZE">INITSIZE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    786786               
    787787               
    … …  
    790790               
    791791               
    792                
     792              <span class="attr">default:</span> <span class="value">1.0</span> 
    793793               
    794794            </h4> 
    … …  
    798798</div> 
    799799             
    800             <h4 id="_STR_SIZE_keyword_STEP">STEP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     800            <h4 id="_str_size_keyword_STEP">STEP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    801801               
    802802               
    … …  
    805805               
    806806               
    807                
     807              <span class="attr">default:</span> <span class="value">0.05</span> 
    808808               
    809809            </h4> 
    … …  
    811811            <div class="comments"> 
    812812 This is the amount the string size will change in each step 
    813  of the interative process of calculating the string size. 
    814  The default value is 0.05. 
     813 of the interactive process of calculating the string size. 
    815814</div> 
    816815             
    … …  
    827826           
    828827          <h4>Version</h4><div class="preformat"> 
    829  $Id: str_size.pro 142 2006-07-21 12:47:49Z navarro $ 
     828 $Id: str_size.pro 157 2006-08-21 09:01:50Z navarro $ 
    830829</div> 
    831830          <h4>History</h4><div class="preformat"> 
    … …  
    850849           
    851850         
     851          <h3>Statistics</h3> 
     852          <table class="statistics"> 
     853            <tr><td>McCabe cyclic</td><td>          11</td></tr> 
     854            <tr><td>McCabe essential</td><td>           1</td></tr> 
     855            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     856          </table> 
    852857           
    853858         
Note: See TracChangeset for help on using the changeset viewer.