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/PLOTS/DIVERS/checkfield.html

    r157 r163  
    736736          <dd></dd>      
    737737           
    738           <dt><p><a href="#_checkfield"><span class="result">result = </span>checkfield(<span class="result">field, procedure</span>, TYPE=<span class="result">TYPE</span>, BOXZOOM=<span class="result">BOXZOOM</span>, DIREC=<span class="result">DIREC</span>, NOQUESTION=<span class="result">NOQUESTION</span>, VECTEUR=<span class="result">VECTEUR</span>, WDEPTH=<span class="result">WDEPTH</span>, _EXTRA=<span class="result">_EXTRA</span>)</a></p><dt> 
     738          <dt><p><a href="#_checkfield"><span class="result">result = </span>checkfield(<span class="result">field, procedure</span>, TYPE=<span class="result">TYPE</span>, BOXZOOM=<span class="result">vector</span>, DIREC=<span class="result">DIREC</span>, NOQUESTION=<span class="result">NOQUESTION</span>, VECTEUR=<span class="result">vetcor</span>, WDEPTH=<span class="result">WDEPTH</span>, _EXTRA=<span class="result">_EXTRA</span>)</a></p><dt> 
    739739          <dd> </dd>     
    740740                 
    … …  
    771771              <span class="attr">required</span> 
    772772               
    773                
     773              <span class="attr">type:</span> <span class="value">string</span> 
    774774               
    775775               
    … …  
    786786              <span class="attr">required</span> 
    787787               
    788                
     788              <span class="attr">type:</span> <span class="value">integer</span> 
    789789               
    790790               
    … …  
    801801               
    802802               
    803                
     803              <span class="attr">type:</span> <span class="value">string</span> 
    804804               
    805805               
    … …  
    807807         
    808808          <div class="comments"> 
    809  It is a string giving the name of the file to be opened. If NAME 
     809 It gives the name of the file to be opened. If NAME 
    810810 does not contain the separating character of directories ('/' under 
    811811 unix for example), the file will be looked for in the current directory. 
    … …  
    818818              <span class="attr">required</span> 
    819819               
    820                
     820              <span class="attr">type:</span> <span class="value">integer</span> 
    821821               
    822822               
    … …  
    838838           
    839839          <h4>Version</h4><div class="preformat"> 
    840  $Id$</div> 
     840 $Id: checkfield.pro 157 2006-08-21 09:01:50Z navarro $</div> 
    841841          <h4>History</h4><div class="preformat"> 
    842842  
    … …  
    860860           
    861861         
     862          <h3>Statistics</h3> 
     863          <table class="statistics"> 
     864            <tr><td>McCabe cyclic</td><td>           1</td></tr> 
     865            <tr><td>McCabe essential</td><td>           1</td></tr> 
     866            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     867          </table> 
    862868           
    863869         
    … …  
    890896              <span class="attr">required</span> 
    891897               
    892                
     898              <span class="attr">type:</span> <span class="value">string</span> 
    893899               
    894900               
    … …  
    967973           
    968974          <h4>Version</h4><div class="preformat"> 
    969  $Id$</div> 
     975 $Id: checkfield.pro 157 2006-08-21 09:01:50Z navarro $</div> 
    970976          <h4>History</h4><div class="preformat"> 
    971977  
    … …  
    989995           
    990996         
     997          <h3>Statistics</h3> 
     998          <table class="statistics"> 
     999            <tr><td>McCabe cyclic</td><td>           1</td></tr> 
     1000            <tr><td>McCabe essential</td><td>           1</td></tr> 
     1001            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     1002          </table> 
    9911003           
    9921004         
    … …  
    10191031              <span class="attr">required</span> 
    10201032               
    1021                
     1033              <span class="attr">type:</span> <span class="value">string</span> 
    10221034               
    10231035               
    … …  
    10961108           
    10971109          <h4>Version</h4><div class="preformat"> 
    1098  $Id$</div> 
     1110 $Id: checkfield.pro 157 2006-08-21 09:01:50Z navarro $</div> 
    10991111          <h4>History</h4><div class="preformat"> 
    11001112  
    … …  
    11181130           
    11191131         
     1132          <h3>Statistics</h3> 
     1133          <table class="statistics"> 
     1134            <tr><td>McCabe cyclic</td><td>           1</td></tr> 
     1135            <tr><td>McCabe essential</td><td>           1</td></tr> 
     1136            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     1137          </table> 
    11201138           
    11211139         
    … …  
    11301148         
    11311149          <p class="header"> 
    1132             <span class="result">result = </span>checkfield(<span class="result"><a href="#_checkfield_param_field">field</a>, <a href="#_checkfield_param_procedure">procedure</a></span>, <a href="#_checkfield_keyword_TYPE">TYPE</a>=<span class="result">TYPE</span>, <a href="#_checkfield_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">BOXZOOM</span>, <a href="#_checkfield_keyword_DIREC">DIREC</a>=<span class="result">DIREC</span>, <a href="#_checkfield_keyword_NOQUESTION">NOQUESTION</a>=<span class="result">NOQUESTION</span>, <a href="#_checkfield_keyword_VECTEUR">VECTEUR</a>=<span class="result">VECTEUR</span>, <a href="#_checkfield_keyword_WDEPTH">WDEPTH</a>=<span class="result">WDEPTH</span>, <a href="#_checkfield_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p> 
     1150            <span class="result">result = </span>checkfield(<span class="result"><a href="#_checkfield_param_field">field</a>, <a href="#_checkfield_param_procedure">procedure</a></span>, <a href="#_checkfield_keyword_TYPE">TYPE</a>=<span class="result">TYPE</span>, <a href="#_checkfield_keyword_BOXZOOM">BOXZOOM</a>=<span class="result">vector</span>, <a href="#_checkfield_keyword_DIREC">DIREC</a>=<span class="result">DIREC</span>, <a href="#_checkfield_keyword_NOQUESTION">NOQUESTION</a>=<span class="result">NOQUESTION</span>, <a href="#_checkfield_keyword_VECTEUR">VECTEUR</a>=<span class="result">vetcor</span>, <a href="#_checkfield_keyword_WDEPTH">WDEPTH</a>=<span class="result">WDEPTH</span>, <a href="#_checkfield_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p> 
    11331151         
    11341152          <div class="comments"> 
    … …  
    11471165              <span class="attr">required</span> 
    11481166               
    1149                
     1167              <span class="attr">type:</span> <span class="value">field</span> 
    11501168               
    11511169               
    … …  
    11531171         
    11541172          <div class="comments"> 
    1155  A field respecting litchamp.pro's criterions. See IDL>xhelp,'litchamp' 
     1173 It respect litchamp.pro's criterions. See IDL>xhelp,'litchamp' 
    11561174</div> 
    11571175             
    … …  
    11991217               
    12001218               
    1201                
    1202                
    1203                
    1204             </h4> 
    1205          
    1206             <div class="comments">  
     1219              <span class="attr">type:</span> <span class="value">vector</span> 
     1220               
     1221               
     1222            </h4> 
     1223         
     1224            <div class="comments"> 
    12071225 Vector indicating the geographic zone on which we want to cut the map.  
    12081226  If BOXZOOM has : 
    … …  
    12521270               
    12531271               
    1254                
     1272              <span class="attr">type:</span> <span class="value">vetcor</span> 
    12551273               
    12561274               
    … …  
    12721290         
    12731291            <div class="comments"> 
    1274  to specify that the field is at W depth instad of T  
     1292 to specify that the field is at W depth instead of T  
    12751293 depth (automatically activated if vargrid eq 'W') 
    12761294 </div> 
    … …  
    12971315           
    12981316          <h4>Version</h4><div class="preformat"> 
    1299  $Id: checkfield.pro 142 2006-07-21 12:47:49Z navarro $ 
     1317 $Id: checkfield.pro 157 2006-08-21 09:01:50Z navarro $ 
    13001318</div> 
    13011319          <h4>History</h4><div class="preformat"> 
    … …  
    13221340           
    13231341         
     1342          <h3>Statistics</h3> 
     1343          <table class="statistics"> 
     1344            <tr><td>McCabe cyclic</td><td>         120</td></tr> 
     1345            <tr><td>McCabe essential</td><td>           1</td></tr> 
     1346            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     1347          </table> 
    13241348           
    13251349         
Note: See TracChangeset for help on using the changeset viewer.