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/INIT/initncdf.html

    r157 r163  
    721721         
    722722          <p class="header"> 
    723             initncdf<span class="result">, <a href="#_initncdf_param_ncfilein">ncfilein</a></span>, <a href="#_initncdf_keyword_XAXISNAME">XAXISNAME</a>=<span class="result">XAXISNAME</span>, <a href="#_initncdf_keyword_YAXISNAME">YAXISNAME</a>=<span class="result">YAXISNAME</span>, <a href="#_initncdf_keyword_ZAXISNAME">ZAXISNAME</a>=<span class="result">ZAXISNAME</span>, <a href="#_initncdf_keyword_MASKNAME">MASKNAME</a>=<span class="result">MASKNAME</span>, <a href="#_initncdf_keyword_INVMASK">INVMASK</a>=<span class="result">INVMASK</span>, <a href="#_initncdf_keyword_USEASMASK">USEASMASK</a>=<span class="result">USEASMASK</span>, <a href="#_initncdf_keyword_MISSING_VALUE">MISSING_VALUE</a>=<span class="result">MISSING_VALUE</span>, <a href="#_initncdf_keyword_START1">START1</a>=<span class="result">START1</span>, <a href="#_initncdf_keyword_XYINDEX">XYINDEX</a>=<span class="result">XYINDEX</span>, <a href="#_initncdf_keyword_ZINDEX">ZINDEX</a>=<span class="result">ZINDEX</span>, <a href="#_initncdf_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p> 
     723            initncdf<span class="result">, <a href="#_initncdf_param_ncfilein">ncfilein</a></span>, <a href="#_initncdf_keyword_XAXISNAME">XAXISNAME</a>=<span class="result">string</span>, <a href="#_initncdf_keyword_YAXISNAME">YAXISNAME</a>=<span class="result">string</span>, <a href="#_initncdf_keyword_ZAXISNAME">ZAXISNAME</a>=<span class="result">string</span>, <a href="#_initncdf_keyword_MASKNAME">MASKNAME</a>=<span class="result">string</span>, <a href="#_initncdf_keyword_INVMASK">INVMASK</a>=<span class="result">INVMASK</span>, <a href="#_initncdf_keyword_USEASMASK">USEASMASK</a>=<span class="result">string</span>, <a href="#_initncdf_keyword_MISSING_VALUE">MISSING_VALUE</a>=<span class="result">MISSING_VALUE</span>, <a href="#_initncdf_keyword_START1">START1</a>=<span class="result">START1</span>, <a href="#_initncdf_keyword_XYINDEX">XYINDEX</a>=<span class="result">XYINDEX</span>, <a href="#_initncdf_keyword_ZINDEX">ZINDEX</a>=<span class="result">ZINDEX</span>, <a href="#_initncdf_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">string</span> 
    741741               
    742742               
     
    760760               
    761761               
    762                
    763                
     762              <span class="attr">type:</span> <span class="value">string</span> 
     763              <span class="attr">default:</span> <span class="value">'x', 'longitude', 'nav_lon' or 'lon'</span> 
    764764               
    765765            </h4> 
     
    768768 A string giving the name of the variable in the file  
    769769 that contains the [xyz]axis.  
    770  for X axis, default name must be 'x', 'longitude', 'nav_lon' or 'lon'. 
    771770      </div> 
    772771             
     
    777776               
    778777               
    779                
    780                
     778              <span class="attr">type:</span> <span class="value">string</span> 
     779              <span class="attr">default:</span> <span class="value">'y', 'latitude', 'nav_lat' or 'lat'</span> 
    781780               
    782781            </h4> 
     
    785784 A string giving the name of the variable in the file  
    786785 that contains the [xyz]axis.  
    787  for Y axis, default name must be 'y', 'latitude', 'nav_lat' or 'lat'. 
    788786</div> 
    789787             
     
    794792               
    795793               
    796                
    797                
     794              <span class="attr">type:</span> <span class="value">string</span> 
     795              <span class="attr">default:</span> <span class="value">'z', 'level', 'lev', 'depth...'</span> 
    798796               
    799797            </h4> 
     
    802800 A string giving the name of the variable in the file  
    803801 that contains the [xyz]axis.  
    804  for Z axis, default name must be 'z', 'level', 'lev', 'depth...' 
    805802</div> 
    806803             
     
    811808               
    812809               
    813                
     810              <span class="attr">type:</span> <span class="value">string</span> 
    814811               
    815812               
     
    842839               
    843840               
    844                
     841              <span class="attr">type:</span> <span class="value">string</span> 
    845842               
    846843               
     
    869866         
    870867            <div class="comments"> 
    871  To define (or redifine if the attribute is 
     868 To define (or redefine if the attribute is 
    872869 already existing) the missing values used with USEASMASK 
    873870 keyword 
     
    948945           
    949946          <h4>Version</h4><div class="preformat"> 
    950  $Id: initncdf.pro 142 2006-07-21 12:47:49Z navarro $ 
     947 $Id: initncdf.pro 157 2006-08-21 09:01:50Z navarro $ 
    951948</div> 
    952949          <h4>History</h4><div class="preformat"> 
     
    977974           
    978975         
     976          <h3>Statistics</h3> 
     977          <table class="statistics"> 
     978            <tr><td>McCabe cyclic</td><td>          54</td></tr> 
     979            <tr><td>McCabe essential</td><td>           1</td></tr> 
     980            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     981          </table> 
    979982           
    980983         
Note: See TracChangeset for help on using the changeset viewer.