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/LECTURE/xncdf_lec.html

    r157 r163  
    726726        <dl> 
    727727           
    728           <dt><p><a href="#_xncdf_lec"><span class="result">result = </span>xncdf_lec(<span class="result">[name]</span>, ATT=<span class="result">ATT</span>, COUNT=<span class="result">COUNT</span>, GROUP=<span class="result">GROUP</span>, OFFSET=<span class="result">OFFSET</span>, IODIR=<span class="result">IODIR</span>, SHIFT=<span class="result">SHIFT</span>, STRIDE=<span class="result">STRIDE</span>, VAR=<span class="result">VAR</span>)</a></p><dt> 
     728          <dt><p><a href="#_xncdf_lec"><span class="result">result = </span>xncdf_lec(<span class="result">[name]</span>, ATT=<span class="result">ATT</span>, COUNT=<span class="result">vector</span>, GROUP=<span class="result">GROUP</span>, OFFSET=<span class="result">vector</span>, IODIR=<span class="result">string</span>, SHIFT=<span class="result">vector</span>, STRIDE=<span class="result">vector</span>, VAR=<span class="result">VAR</span>)</a></p><dt> 
    729729          <dd> </dd>     
    730730           
    … …  
    752752         
    753753          <p class="header"> 
    754             <span class="result">result = </span>xncdf_lec(<span class="result">[<a href="#_xncdf_lec_param_name">name</a>]</span>, <a href="#_xncdf_lec_keyword_ATT">ATT</a>=<span class="result">ATT</span>, <a href="#_xncdf_lec_keyword_COUNT">COUNT</a>=<span class="result">COUNT</span>, <a href="#_xncdf_lec_keyword_GROUP">GROUP</a>=<span class="result">GROUP</span>, <a href="#_xncdf_lec_keyword_OFFSET">OFFSET</a>=<span class="result">OFFSET</span>, <a href="#_xncdf_lec_keyword_IODIR">IODIR</a>=<span class="result">IODIR</span>, <a href="#_xncdf_lec_keyword_SHIFT">SHIFT</a>=<span class="result">SHIFT</span>, <a href="#_xncdf_lec_keyword_STRIDE">STRIDE</a>=<span class="result">STRIDE</span>, <a href="#_xncdf_lec_keyword_VAR">VAR</a>=<span class="result">VAR</span>)</p> 
     754            <span class="result">result = </span>xncdf_lec(<span class="result">[<a href="#_xncdf_lec_param_name">name</a>]</span>, <a href="#_xncdf_lec_keyword_ATT">ATT</a>=<span class="result">ATT</span>, <a href="#_xncdf_lec_keyword_COUNT">COUNT</a>=<span class="result">vector</span>, <a href="#_xncdf_lec_keyword_GROUP">GROUP</a>=<span class="result">GROUP</span>, <a href="#_xncdf_lec_keyword_OFFSET">OFFSET</a>=<span class="result">vector</span>, <a href="#_xncdf_lec_keyword_IODIR">IODIR</a>=<span class="result">string</span>, <a href="#_xncdf_lec_keyword_SHIFT">SHIFT</a>=<span class="result">vector</span>, <a href="#_xncdf_lec_keyword_STRIDE">STRIDE</a>=<span class="result">vector</span>, <a href="#_xncdf_lec_keyword_VAR">VAR</a>=<span class="result">VAR</span>)</p> 
    755755         
    756756          <div class="comments"> 
    … …  
    776776               
    777777               
    778                
     778              <span class="attr">type:</span> <span class="value">string</span> 
    779779               
    780780               
    781781            </h4> 
    782782         
    783           <div class="comments"> 
    784  It is a string giving the name of the file to be opened. If NAME  
     783          <div class="comments">  
     784 It give the name of the file to be opened. If NAME  
    785785 does not contain the separating character of directories ('/' under  
    786786 unix for example), the file will be looked for in the current directory. 
    … …  
    813813               
    814814               
    815                
     815              <span class="attr">type:</span> <span class="value">vector</span> 
    816816               
    817817               
    … …  
    848848               
    849849               
    850                
    851                
     850              <span class="attr">type:</span> <span class="value">vector</span> 
     851              <span class="attr">default:</span> <span class="value">[0, 0,...]</span> 
    852852               
    853853            </h4> 
    … …  
    864864               
    865865               
    866                
     866              <span class="attr">type:</span> <span class="value">string</span> 
    867867               
    868868               
    … …  
    870870         
    871871            <div class="comments"> 
    872  It is a string containing the directory where to go look for the file to be read. 
     872 It contains the directory where to go look for the file to be read. 
    873873 If NAME does not contain the separating character of directories ('/' under  
    874874 unix for example), the file will be called iodir+nom_fichier. 
    … …  
    881881               
    882882               
    883                
    884                
     883              <span class="attr">type:</span> <span class="value">vector</span> 
     884              <span class="attr">default:</span> <span class="value">[0, 0,...]</span> 
    885885               
    886886            </h4> 
    887887         
    888888            <div class="comments"> 
    889  A vector of integers, specifing for each dimension how much we have to shift it.  
     889 A vector of integers, specifying for each dimension how much we have to shift it.  
    890890 By default, it is [0,0,...]. See the function shift for more explanations. BEWARE,  
    891  the shift is done on the biggest array before a possible reduction determinated  
     891 the shift is done on the biggest array before a possible reduction determined  
    892892 by OFFSET and COUNT. On the other hand, it is done after the possible extraction  
    893893 created by the STRIDE. 
    … …  
    900900               
    901901               
    902                
    903                
     902              <span class="attr">type:</span> <span class="value">vector</span> 
     903              <span class="attr">default:</span> <span class="value">[1, 1,...]</span> 
    904904               
    905905            </h4> 
    … …  
    932932           
    933933          <h4>Version</h4><div class="preformat"> 
    934  $Id: xncdf_lec.pro 150 2006-08-09 10:12:54Z navarro $</div> 
     934 $Id: xncdf_lec.pro 157 2006-08-21 09:01:50Z navarro $</div> 
    935935          <h4>History</h4><div class="preformat"> 
    936936 Sebastien Masson (smasson@lodyc.jussieu.fr) 
    … …  
    958958motcle</div> 
    959959         
     960          <h3>Statistics</h3> 
     961          <table class="statistics"> 
     962            <tr><td>McCabe cyclic</td><td>          23</td></tr> 
     963            <tr><td>McCabe essential</td><td>           1</td></tr> 
     964            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     965          </table> 
    960966           
    961967         
    … …  
    10021008           
    10031009          <h4>Version</h4><div class="preformat"> 
    1004  $Id: xncdf_lec.pro 150 2006-08-09 10:12:54Z navarro $</div> 
     1010 $Id: xncdf_lec.pro 157 2006-08-21 09:01:50Z navarro $</div> 
    10051011           
    10061012           
    … …  
    10261032motcle</div> 
    10271033         
     1034          <h3>Statistics</h3> 
     1035          <table class="statistics"> 
     1036            <tr><td>McCabe cyclic</td><td>          34</td></tr> 
     1037            <tr><td>McCabe essential</td><td>           1</td></tr> 
     1038            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     1039          </table> 
    10281040           
    10291041         
    … …  
    10521064              <span class="attr">required</span> 
    10531065               
    1054                
     1066              <span class="attr">type:</span> <span class="value">scalar</span> 
    10551067               
    10561068               
    … …  
    10581070         
    10591071          <div class="comments"> 
    1060  It is a scalar containing the identity of the father widget which was  
     1072 It contains the identity of the father widget which was  
    10611073 created by xncdf_lec and which has allowed to select the variable to be read. 
    10621074 
    … …  
    10731085           
    10741086          <h4>Version</h4><div class="preformat"> 
    1075  $Id: xncdf_lec.pro 150 2006-08-09 10:12:54Z navarro $</div> 
     1087 $Id: xncdf_lec.pro 157 2006-08-21 09:01:50Z navarro $</div> 
    10761088           
    10771089           
    … …  
    10961108motcle</div> 
    10971109         
     1110          <h3>Statistics</h3> 
     1111          <table class="statistics"> 
     1112            <tr><td>McCabe cyclic</td><td>           7</td></tr> 
     1113            <tr><td>McCabe essential</td><td>           1</td></tr> 
     1114            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     1115          </table> 
    10981116           
    10991117         
    … …  
    11401158           
    11411159          <h4>Version</h4><div class="preformat"> 
    1142  $Id: xncdf_lec.pro 150 2006-08-09 10:12:54Z navarro $</div> 
     1160 $Id: xncdf_lec.pro 157 2006-08-21 09:01:50Z navarro $</div> 
    11431161           
    11441162           
    … …  
    11621180motcle</div> 
    11631181         
     1182          <h3>Statistics</h3> 
     1183          <table class="statistics"> 
     1184            <tr><td>McCabe cyclic</td><td>           5</td></tr> 
     1185            <tr><td>McCabe essential</td><td>           1</td></tr> 
     1186            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     1187          </table> 
    11641188           
    11651189         
Note: See TracChangeset for help on using the changeset viewer.