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/STATISTICS/a_timecorrelate.html

    r157 r163  
    724724        <dl> 
    725725           
    726           <dt><p><a href="#_TimeAuto_Cov"><span class="result">result = </span>TimeAuto_Cov(<span class="result">X, M, nT</span>, Double=<span class="result">Double</span>, zero2nan=<span class="result">zero2nan</span>)</a></p><dt> 
     726          <dt><p><a href="#_timeauto_cov"><span class="result">result = </span>timeauto_cov(<span class="result">X, M, nT</span>, Double=<span class="result">Double</span>, zero2nan=<span class="result">zero2nan</span>)</a></p><dt> 
    727727          <dd></dd>      
    728728           
    729           <dt><p><a href="#_A_TimeCorrelate"><span class="result">result = </span>A_TimeCorrelate(<span class="result">X, Lag</span>, COVARIANCE=<span class="result">COVARIANCE</span>, DOUBLE=<span class="result">DOUBLE</span>)</a></p><dt> 
     729          <dt><p><a href="#_a_timecorrelate"><span class="result">result = </span>a_timecorrelate(<span class="result">X, Lag</span>, COVARIANCE=<span class="result">COVARIANCE</span>, DOUBLE=<span class="result">DOUBLE</span>)</a></p><dt> 
    730730          <dd></dd>      
    731731                 
     
    737737         
    738738 
    739         <div class="routine_details" id="_TimeAuto_Cov"> 
    740  
    741           <h2><a class="top" href="#container">top</a>TimeAuto_Cov <span class="categories"> 
     739        <div class="routine_details" id="_timeauto_cov"> 
     740 
     741          <h2><a class="top" href="#container">top</a>timeauto_cov <span class="categories"> 
    742742 Statistics 
    743743</span></h2> 
    744744         
    745745          <p class="header"> 
    746             <span class="result">result = </span>TimeAuto_Cov(<span class="result"><a href="#_TimeAuto_Cov_param_X">X</a>, <a href="#_TimeAuto_Cov_param_M">M</a>, <a href="#_TimeAuto_Cov_param_nT">nT</a></span>, <a href="#_TimeAuto_Cov_keyword_Double">Double</a>=<span class="result">Double</span>, <a href="#_TimeAuto_Cov_keyword_zero2nan">zero2nan</a>=<span class="result">zero2nan</span>)</p> 
     746            <span class="result">result = </span>timeauto_cov(<span class="result"><a href="#_timeauto_cov_param_X">X</a>, <a href="#_timeauto_cov_param_M">M</a>, <a href="#_timeauto_cov_param_nT">nT</a></span>, <a href="#_timeauto_cov_keyword_Double">Double</a>=<span class="result">Double</span>, <a href="#_timeauto_cov_keyword_zero2nan">zero2nan</a>=<span class="result">zero2nan</span>)</p> 
    747747         
    748748          <div class="comments"></div> 
     
    754754         
    755755             
    756             <h4 id="_TimeAuto_Cov_param_X">X&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     756            <h4 id="_timeauto_cov_param_X">X&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    757757              <span class="attr">in</span> 
    758758               
     
    760760              <span class="attr">required</span> 
    761761               
    762                
     762              <span class="attr">type:</span> <span class="value">array</span> 
    763763               
    764764               
     
    766766         
    767767          <div class="comments"> 
    768  An Array which last dimension is the time dimension os 
     768 An Array which last dimension is the time dimension so 
    769769 size n. 
    770770</div> 
    771771             
    772             <h4 id="_TimeAuto_Cov_param_M">M&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     772            <h4 id="_timeauto_cov_param_M">M&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    773773               
    774774               
     
    785785</div> 
    786786             
    787             <h4 id="_TimeAuto_Cov_param_nT">nT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     787            <h4 id="_timeauto_cov_param_nT">nT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    788788               
    789789               
     
    807807            <h3>Keywords</h3> 
    808808             
    809             <h4 id="_TimeAuto_Cov_keyword_Double">Double&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     809            <h4 id="_timeauto_cov_keyword_Double">Double&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    810810               
    811811               
     
    823823</div> 
    824824             
    825             <h4 id="_TimeAuto_Cov_keyword_zero2nan">zero2nan&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     825            <h4 id="_timeauto_cov_keyword_zero2nan">zero2nan&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    826826               
    827827               
     
    846846           
    847847          <h4>Version</h4><div class="preformat"> 
    848  $Id: a_timecorrelate.pro 150 2006-08-09 10:12:54Z navarro $ 
     848 $Id: a_timecorrelate.pro 157 2006-08-21 09:01:50Z navarro $ 
    849849</div> 
    850850          <h4>History</h4><div class="preformat"> 
     
    867867           
    868868         
     869          <h3>Statistics</h3> 
     870          <table class="statistics"> 
     871            <tr><td>McCabe cyclic</td><td>           8</td></tr> 
     872            <tr><td>McCabe essential</td><td>           1</td></tr> 
     873            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     874          </table> 
    869875           
    870876         
     
    872878         
    873879 
    874         <div class="routine_details" id="_A_TimeCorrelate"> 
    875  
    876           <h2><a class="top" href="#container">top</a>A_TimeCorrelate <span class="categories"> 
     880        <div class="routine_details" id="_a_timecorrelate"> 
     881 
     882          <h2><a class="top" href="#container">top</a>a_timecorrelate <span class="categories"> 
    877883 Statistics 
    878884</span></h2> 
    879885         
    880886          <p class="header"> 
    881             <span class="result">result = </span>A_TimeCorrelate(<span class="result"><a href="#_A_TimeCorrelate_param_X">X</a>, <a href="#_A_TimeCorrelate_param_Lag">Lag</a></span>, <a href="#_A_TimeCorrelate_keyword_COVARIANCE">COVARIANCE</a>=<span class="result">COVARIANCE</span>, <a href="#_A_TimeCorrelate_keyword_DOUBLE">DOUBLE</a>=<span class="result">DOUBLE</span>)</p> 
     887            <span class="result">result = </span>a_timecorrelate(<span class="result"><a href="#_a_timecorrelate_param_X">X</a>, <a href="#_a_timecorrelate_param_Lag">Lag</a></span>, <a href="#_a_timecorrelate_keyword_COVARIANCE">COVARIANCE</a>=<span class="result">COVARIANCE</span>, <a href="#_a_timecorrelate_keyword_DOUBLE">DOUBLE</a>=<span class="result">DOUBLE</span>)</p> 
    882888         
    883889          <div class="comments"></div> 
     
    889895         
    890896             
    891             <h4 id="_A_TimeCorrelate_param_X">X&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     897            <h4 id="_a_timecorrelate_param_X">X&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    892898              <span class="attr">in</span> 
    893899               
     
    895901              <span class="attr">required</span> 
    896902               
    897                
     903              <span class="attr">type:</span> <span class="value">array</span> 
    898904               
    899905               
     
    901907         
    902908          <div class="comments"> 
    903  An Array which last dimension is the time dimension os 
     909 An Array which last dimension is the time dimension so 
    904910 size n. 
    905911</div> 
    906912             
    907             <h4 id="_A_TimeCorrelate_param_Lag">Lag&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     913            <h4 id="_a_timecorrelate_param_Lag">Lag&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    908914              <span class="attr">in</span> 
    909915               
     
    911917              <span class="attr">required</span> 
    912918               
    913                
     919              <span class="attr">type:</span> <span class="value">scalar or vector</span> 
    914920               
    915921               
     
    929935            <h3>Keywords</h3> 
    930936             
    931             <h4 id="_A_TimeCorrelate_keyword_COVARIANCE">COVARIANCE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     937            <h4 id="_a_timecorrelate_keyword_COVARIANCE">COVARIANCE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    932938               
    933939               
     
    945951</div> 
    946952             
    947             <h4 id="_A_TimeCorrelate_keyword_DOUBLE">DOUBLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     953            <h4 id="_a_timecorrelate_keyword_DOUBLE">DOUBLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    948954               
    949955               
     
    977983           
    978984          <h4>Version</h4><div class="preformat"> 
    979  $Id: a_timecorrelate.pro 150 2006-08-09 10:12:54Z navarro $ 
     985 $Id: a_timecorrelate.pro 157 2006-08-21 09:01:50Z navarro $ 
    980986</div> 
    981987          <h4>History</h4><div class="preformat"> 
     
    10031009           
    10041010         
     1011          <h3>Statistics</h3> 
     1012          <table class="statistics"> 
     1013            <tr><td>McCabe cyclic</td><td>          13</td></tr> 
     1014            <tr><td>McCabe essential</td><td>           1</td></tr> 
     1015            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     1016          </table> 
    10051017           
    10061018         
Note: See TracChangeset for help on using the changeset viewer.