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/ToBeReviewed/PLOTS/VECTEUR
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/VECTEUR/ajoutvect.html

    r157 r163  
    721721         
    722722          <p class="header"> 
    723             ajoutvect<span class="result">, <a href="#_ajoutvect_param_vecteur">vecteur</a>, <a href="#_ajoutvect_param_vectlegende">vectlegende</a></span>, <a href="#_ajoutvect_keyword_UNVECTSUR">UNVECTSUR</a>=<span class="result">UNVECTSUR</span>, <a href="#_ajoutvect_keyword_VECTMIN">VECTMIN</a>=<span class="result">VECTMIN</span>, <a href="#_ajoutvect_keyword_VECTMAX">VECTMAX</a>=<span class="result">VECTMAX</span>, <a href="#_ajoutvect_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p> 
     723            ajoutvect<span class="result">, <a href="#_ajoutvect_param_vecteur">vecteur</a>, <a href="#_ajoutvect_param_vectlegende">vectlegende</a></span>, <a href="#_ajoutvect_keyword_UNVECTSUR">UNVECTSUR</a>=<span class="result">scalar or array</span>, <a href="#_ajoutvect_keyword_VECTMIN">VECTMIN</a>=<span class="result">VECTMIN</span>, <a href="#_ajoutvect_keyword_VECTMAX">VECTMAX</a>=<span class="result">VECTMAX</span>, <a href="#_ajoutvect_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p> 
    724724         
    725725          <div class="comments"> 
     
    738738              <span class="attr">required</span> 
    739739               
    740                
     740              <span class="attr">type:</span> <span class="value">vector</span> 
    741741               
    742742               
     
    772772               
    773773               
    774                
     774              <span class="attr">type:</span> <span class="value">scalar or array</span> 
    775775               
    776776               
     
    837837           
    838838          <h4>Version</h4><div class="preformat"> 
    839  $Id: ajoutvect.pro 142 2006-07-21 12:47:49Z navarro $  
     839 $Id: ajoutvect.pro 157 2006-08-21 09:01:50Z navarro $  
    840840 </div> 
    841841          <h4>History</h4><div class="preformat"> 
     
    863863           
    864864         
     865          <h3>Statistics</h3> 
     866          <table class="statistics"> 
     867            <tr><td>McCabe cyclic</td><td>          38</td></tr> 
     868            <tr><td>McCabe essential</td><td>           1</td></tr> 
     869            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     870          </table> 
    865871           
    866872         
  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/VECTEUR/vecteur.html

    r157 r163  
    785785           
    786786          <h4>Version</h4><div class="preformat"> 
    787  $Id$</div> 
     787 $Id: vecteur.pro 157 2006-08-21 09:01:50Z navarro $</div> 
    788788          <h4>History</h4><div class="preformat"> 
    789789  
     
    807807           
    808808         
     809          <h3>Statistics</h3> 
     810          <table class="statistics"> 
     811            <tr><td>McCabe cyclic</td><td>           1</td></tr> 
     812            <tr><td>McCabe essential</td><td>           1</td></tr> 
     813            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     814          </table> 
    809815           
    810816         
     
    885891           
    886892          <h4>Version</h4><div class="preformat"> 
    887  $Id$</div> 
     893 $Id: vecteur.pro 157 2006-08-21 09:01:50Z navarro $</div> 
    888894          <h4>History</h4><div class="preformat"> 
    889895  
     
    907913           
    908914         
     915          <h3>Statistics</h3> 
     916          <table class="statistics"> 
     917            <tr><td>McCabe cyclic</td><td>           2</td></tr> 
     918            <tr><td>McCabe essential</td><td>           1</td></tr> 
     919            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     920          </table> 
    909921           
    910922         
     
    10241036               
    10251037               
    1026                
     1038              <span class="attr">default:</span> <span class="value">between .5 and 1.5 cm</span> 
    10271039               
    10281040            </h4> 
    10291041         
    10301042            <div class="comments"> 
    1031  The lenth in cm that must measure the arrow normed normeref. By default,  
    1032  it is ajusted t othe drawing and included between .5 and 1.5 cm. 
     1043 The length in cm that must measure the arrow normed normeref. By default,  
     1044 it is adjusted to other drawing and included between .5 and 1.5 cm. 
    10331045</div> 
    10341046             
     
    10711083               
    10721084               
    1073                
     1085              <span class="attr">default:</span> <span class="value">0</span> 
    10741086               
    10751087            </h4> 
     
    10861098               
    10871099               
    1088                
     1100              <span class="attr">default:</span> <span class="value">1</span> 
    10891101               
    10901102            </h4> 
    10911103         
    10921104            <div class="comments"> 
    1093  The thick of the arrow. 1 by default  
     1105 The thick of the arrow.  
    10941106</div> 
    10951107             
     
    11061118         
    11071119            <div class="comments"> 
    1108  Vector composed of 2 elements specifing the position on DATA coordinates  
    1109  from de begining of the reference vector. By default at the right bottom  
     1120 Vector composed of 2 elements specifying the position on DATA coordinates  
     1121 from the beginning of the reference vector. By default at the right bottom  
    11101122 of the drawing. 
    11111123</div> 
     
    11621174           
    11631175          <h4>Version</h4><div class="preformat"> 
    1164  $Id: vecteur.pro 142 2006-07-21 12:47:49Z navarro $  
     1176 $Id: vecteur.pro 157 2006-08-21 09:01:50Z navarro $  
    11651177</div> 
    11661178          <h4>History</h4><div class="preformat"> 
     
    11921204           
    11931205         
     1206          <h3>Statistics</h3> 
     1207          <table class="statistics"> 
     1208            <tr><td>McCabe cyclic</td><td>          20</td></tr> 
     1209            <tr><td>McCabe essential</td><td>           1</td></tr> 
     1210            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     1211          </table> 
    11941212           
    11951213         
  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/VECTEUR/velovect.html

    r157 r163  
    717717         
    718718 
    719         <div class="routine_details" id="_VELOVECT"> 
    720  
    721           <h2><a class="top" href="#container">top</a>VELOVECT <span class="categories"> 
     719        <div class="routine_details" id="_velovect"> 
     720 
     721          <h2><a class="top" href="#container">top</a>velovect <span class="categories"> 
    722722 Plotting, two-dimensional. 
    723723 
     
    725725         
    726726          <p class="header"> 
    727             VELOVECT<span class="result">, <a href="#_VELOVECT_param_U">U</a>, <a href="#_VELOVECT_param_V">V</a>[, <a href="#_VELOVECT_param_X">X</a>][, <a href="#_VELOVECT_param_Y">Y</a>]</span>, <a href="#_VELOVECT_keyword_Missing">Missing</a>=<span class="result">Missing</span>, <a href="#_VELOVECT_keyword_Length">Length</a>=<span class="result">Length</span>, <a href="#_VELOVECT_keyword_Dots">Dots</a>=<span class="result">Dots</span>, <a href="#_VELOVECT_keyword_Color">Color</a>=<span class="result">Color</span>, <a href="#_VELOVECT_keyword_CLIP">CLIP</a>=<span class="result">CLIP</span>, <a href="#_VELOVECT_keyword_NOCLIP">NOCLIP</a>=<span class="result">NOCLIP</span>, <a href="#_VELOVECT_keyword_OVERPLOT">OVERPLOT</a>=<span class="result">OVERPLOT</span>, <a href="#_VELOVECT_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p> 
     727            velovect<span class="result">, <a href="#_velovect_param_U">U</a>, <a href="#_velovect_param_V">V</a>[, <a href="#_velovect_param_X">X</a>][, <a href="#_velovect_param_Y">Y</a>]</span>, <a href="#_velovect_keyword_Missing">Missing</a>=<span class="result">Missing</span>, <a href="#_velovect_keyword_Length">Length</a>=<span class="result">Length</span>, <a href="#_velovect_keyword_Dots">Dots</a>=<span class="result">Dots</span>, <a href="#_velovect_keyword_Color">Color</a>=<span class="result">Color</span>, <a href="#_velovect_keyword_CLIP">CLIP</a>=<span class="result">CLIP</span>, <a href="#_velovect_keyword_NOCLIP">NOCLIP</a>=<span class="result">NOCLIP</span>, <a href="#_velovect_keyword_OVERPLOT">OVERPLOT</a>=<span class="result">OVERPLOT</span>, <a href="#_velovect_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p> 
    728728         
    729729          <div class="comments">  
     
    736736         
    737737             
    738             <h4 id="_VELOVECT_param_U">U&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     738            <h4 id="_velovect_param_U">U&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    739739              <span class="attr">in</span> 
    740740               
     
    752752</div> 
    753753             
    754             <h4 id="_VELOVECT_param_V">V&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     754            <h4 id="_velovect_param_V">V&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    755755              <span class="attr">in</span> 
    756756               
     
    775775</div> 
    776776             
    777             <h4 id="_VELOVECT_param_X">X&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     777            <h4 id="_velovect_param_X">X&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    778778              <span class="attr">in</span> 
    779779               
     
    781781               
    782782               
    783                
     783              <span class="attr">type:</span> <span class="value">vector</span> 
    784784               
    785785               
     
    787787         
    788788          <div class="comments"> 
    789  Optional abcissae values.  X must be a vector with a length  
     789 Optional abscissa values.  X must be a vector with a length  
    790790 equal to the first dimension of U and V. 
    791791</div> 
    792792             
    793             <h4 id="_VELOVECT_param_Y">Y&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     793            <h4 id="_velovect_param_Y">Y&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    794794              <span class="attr">in</span> 
    795795               
     
    797797               
    798798               
    799                
     799              <span class="attr">type:</span> <span class="value">vector</span> 
    800800               
    801801               
     
    814814            <h3>Keywords</h3> 
    815815             
    816             <h4 id="_VELOVECT_keyword_Missing">Missing&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     816            <h4 id="_velovect_keyword_Missing">Missing&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    817817               
    818818               
     
    830830</div> 
    831831             
    832             <h4 id="_VELOVECT_keyword_Length">Length&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     832            <h4 id="_velovect_keyword_Length">Length&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    833833               
    834834               
     
    837837               
    838838               
    839                
     839              <span class="attr">default:</span> <span class="value">1.0</span> 
    840840               
    841841            </h4> 
     
    846846</div> 
    847847             
    848             <h4 id="_VELOVECT_keyword_Dots">Dots&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     848            <h4 id="_velovect_keyword_Dots">Dots&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    849849               
    850850               
     
    863863</div> 
    864864             
    865             <h4 id="_VELOVECT_keyword_Color">Color&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     865            <h4 id="_velovect_keyword_Color">Color&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    866866               
    867867               
     
    878878</div> 
    879879             
    880             <h4 id="_VELOVECT_keyword_CLIP">CLIP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     880            <h4 id="_velovect_keyword_CLIP">CLIP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    881881               
    882882               
     
    892892 </div> 
    893893             
    894             <h4 id="_VELOVECT_keyword_NOCLIP">NOCLIP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     894            <h4 id="_velovect_keyword_NOCLIP">NOCLIP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    895895               
    896896               
     
    906906</div> 
    907907             
    908             <h4 id="_VELOVECT_keyword_OVERPLOT">OVERPLOT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     908            <h4 id="_velovect_keyword_OVERPLOT">OVERPLOT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    909909               
    910910               
     
    923923 </div> 
    924924             
    925             <h4 id="_VELOVECT_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     925            <h4 id="_velovect_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    926926               
    927927               
     
    988988           
    989989         
     990          <h3>Statistics</h3> 
     991          <table class="statistics"> 
     992            <tr><td>McCabe cyclic</td><td>          19</td></tr> 
     993            <tr><td>McCabe essential</td><td>           3</td></tr> 
     994            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     995          </table> 
    990996           
    991997         
Note: See TracChangeset for help on using the changeset viewer.