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/LECTURE/GRIB
Files:
14 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/GRIB/bit2int.html

    r157 r163  
    699699      </div> 
    700700 
    701       <div id="file_comments"></div> 
     701      <div id="file_comments"> 
     702 
     703</div> 
    702704 
    703705       
    … …  
    714716        <div class="routine_details" id="_bit2int"> 
    715717 
    716           <h2><a class="top" href="#container">top</a>bit2int </h2> 
     718          <h2><a class="top" href="#container">top</a>bit2int <span class="categories"> 
     719 
     720</span></h2> 
    717721         
    718722          <p class="header"> 
    719723            <span class="result">result = </span>bit2int(<span class="result"><a href="#_bit2int_param_bitin">bitin</a></span>, <a href="#_bit2int_keyword_checkneg">checkneg</a>=<span class="result">checkneg</span>)</p> 
    720724         
    721           <div class="comments"> 
    722 </div> 
    723  
    724            
     725          <div class="comments"></div> 
     726 
     727          <h3>Return value</h3><div class="preformat"> 
     728 
     729</div> 
    725730 
    726731           
    … …  
    739744            </h4> 
    740745         
    741           <div class="comments"></div> 
     746          <div class="comments"> 
     747 
     748</div> 
    742749             
    743750 
    … …  
    759766            </h4> 
    760767         
    761             <div class="comments"></div> 
     768            <div class="comments"> 
     769 
     770</div> 
    762771             
    763772           
    764773 
    765            
    766            
    767            
    768            
    769            
     774          <h3>Examples</h3><div class="preformat"> 
     775 
     776</div> 
     777          <h3>Version history</h3> 
     778           
     779          <h4>Version</h4><div class="preformat"> 
     780 $Id$ 
     781</div> 
     782          <h4>History</h4><div class="preformat"> 
     783 
     784</div> 
    770785           
    771786           
    … …  
    776791 seb 
    777792</div> 
    778            
    779          
    780            
    781            
    782            
    783            
    784            
    785            
    786            
    787          
     793          <h4>Restrictions</h4><div class="preformat"> 
     794 
     795</div> 
     796         
     797          <h3>Other attributes</h3> 
     798           
     799           
     800          <h4>Uses routines</h4><div class="preformat"> 
     801 
     802</div> 
     803           
     804           
     805           
     806         
     807          <h3>Statistics</h3> 
     808          <table class="statistics"> 
     809            <tr><td>McCabe cyclic</td><td>           4</td></tr> 
     810            <tr><td>McCabe essential</td><td>           1</td></tr> 
     811            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     812          </table> 
    788813           
    789814         

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/GRIB/directory-overview.html

    r157 r163  
    702702       
    703703        <dt><a href="bit2int.html?format=raw">bit2int.pro</a></dt> 
    704         <dd></dd> 
     704        <dd>  </dd> 
    705705       
    706706        <dt><a href="read_grib.html?format=raw">read_grib.pro</a></dt> 
    … …  
    723723       
    724724        <dt><a href="read_gribtable.html?format=raw">read_gribtable.pro</a></dt> 
    725         <dd></dd> 
     725        <dd>  Read contents of a gribtable.</dd> 
    726726       
    727727        <dt><a href="scan_grib_code.html?format=raw">scan_grib_code.pro</a></dt> 

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/GRIB/read_grib.html

    r157 r163  
    721721         
    722722          <p class="header"> 
    723             <span class="result">result = </span>read_grib(<span class="result"><a href="#_read_grib_param_varcode">varcode</a>[, <a href="#_read_grib_param_date1">date1</a>][, <a href="#_read_grib_param_date2">date2</a>]</span>, <a href="#_read_grib_keyword_file">file</a>=<span class="result">file</span>)</p> 
     723            <span class="result">result = </span>read_grib(<span class="result"><a href="#_read_grib_param_varcode">varcode</a>[, <a href="#_read_grib_param_date1">date1</a>][, <a href="#_read_grib_param_date2">date2</a>]</span>, <a href="#_read_grib_keyword_file">file</a>=<span class="result">array or string</span>)</p> 
    724724         
    725725          <div class="comments"></div> 
    … …  
    791791               
    792792               
    793                
     793              <span class="attr">type:</span> <span class="value">array or string</span> 
    794794               
    795795               
    … …  
    808808           
    809809          <h4>Version</h4><div class="preformat"> 
    810  $Id$</div> 
     810 $Id: read_grib.pro 157 2006-08-21 09:01:50Z navarro $</div> 
    811811          <h4>History</h4><div class="preformat"> 
    812812  
    … …  
    830830           
    831831         
     832          <h3>Statistics</h3> 
     833          <table class="statistics"> 
     834            <tr><td>McCabe cyclic</td><td>          34</td></tr> 
     835            <tr><td>McCabe essential</td><td>           1</td></tr> 
     836            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     837          </table> 
    832838           
    833839         

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/GRIB/read_grib_bds.html

    r157 r163  
    804804           
    805805          <h4>Version</h4><div class="preformat"> 
    806  $Id$</div> 
     806 $Id: read_grib_bds.pro 157 2006-08-21 09:01:50Z navarro $</div> 
    807807          <h4>History</h4><div class="preformat"> 
    808808  
    … …  
    826826           
    827827         
     828          <h3>Statistics</h3> 
     829          <table class="statistics"> 
     830            <tr><td>McCabe cyclic</td><td>          10</td></tr> 
     831            <tr><td>McCabe essential</td><td>           1</td></tr> 
     832            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     833          </table> 
    828834           
    829835         

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/GRIB/read_grib_end.html

    r157 r163  
    774774           
    775775          <h4>Version</h4><div class="preformat"> 
    776  $Id$</div> 
     776 $Id: read_grib_end.pro 157 2006-08-21 09:01:50Z navarro $</div> 
    777777          <h4>History</h4><div class="preformat"> 
    778778  
    … …  
    796796           
    797797         
     798          <h3>Statistics</h3> 
     799          <table class="statistics"> 
     800            <tr><td>McCabe cyclic</td><td>           2</td></tr> 
     801            <tr><td>McCabe essential</td><td>           1</td></tr> 
     802            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     803          </table> 
    798804           
    799805         

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/GRIB/read_grib_gds.html

    r157 r163  
    774774           
    775775          <h4>Version</h4><div class="preformat"> 
    776  $Id$</div> 
     776 $Id: read_grib_gds.pro 157 2006-08-21 09:01:50Z navarro $</div> 
    777777          <h4>History</h4><div class="preformat"> 
    778778  
    … …  
    796796           
    797797         
     798          <h3>Statistics</h3> 
     799          <table class="statistics"> 
     800            <tr><td>McCabe cyclic</td><td>          14</td></tr> 
     801            <tr><td>McCabe essential</td><td>           1</td></tr> 
     802            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     803          </table> 
    798804           
    799805         

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/GRIB/read_grib_is.html

    r157 r163  
    774774           
    775775          <h4>Version</h4><div class="preformat"> 
    776  $Id$</div> 
     776 $Id: read_grib_is.pro 157 2006-08-21 09:01:50Z navarro $</div> 
    777777          <h4>History</h4><div class="preformat"> 
    778778  
    … …  
    796796           
    797797         
     798          <h3>Statistics</h3> 
     799          <table class="statistics"> 
     800            <tr><td>McCabe cyclic</td><td>           3</td></tr> 
     801            <tr><td>McCabe essential</td><td>           1</td></tr> 
     802            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     803          </table> 
    798804           
    799805         

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/GRIB/read_grib_pds.html

    r157 r163  
    774774           
    775775          <h4>Version</h4><div class="preformat"> 
    776  $Id$</div> 
     776 $Id: read_grib_pds.pro 157 2006-08-21 09:01:50Z navarro $</div> 
    777777          <h4>History</h4><div class="preformat"> 
    778778  
    … …  
    796796           
    797797         
     798          <h3>Statistics</h3> 
     799          <table class="statistics"> 
     800            <tr><td>McCabe cyclic</td><td>           1</td></tr> 
     801            <tr><td>McCabe essential</td><td>           1</td></tr> 
     802            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     803          </table> 
    798804           
    799805         

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/GRIB/read_gribtable.html

    r157 r163  
    699699      </div> 
    700700 
    701       <div id="file_comments"></div> 
     701      <div id="file_comments"> 
     702 Read contents of a gribtable. Gribtables are located 
     703 in the gribtables subdirectory of HIPHOP 
     704</div> 
    702705 
    703706       
    … …  
    714717        <div class="routine_details" id="_read_gribtable"> 
    715718 
    716           <h2><a class="top" href="#container">top</a>read_gribtable </h2> 
     719          <h2><a class="top" href="#container">top</a>read_gribtable <span class="categories"> 
     720 
     721</span></h2> 
    717722         
    718723          <p class="header"> 
    719724            read_gribtable<span class="result">, <a href="#_read_gribtable_param_tablename">tablename</a></span>, <a href="#_read_gribtable_keyword_parmtabl">parmtabl</a>=<span class="result">parmtabl</span>, <a href="#_read_gribtable_keyword_center">center</a>=<span class="result">center</span>, <a href="#_read_gribtable_keyword_subcenter">subcenter</a>=<span class="result">subcenter</span>, <a href="#_read_gribtable_keyword_tablnum">tablnum</a>=<span class="result">tablnum</span></p> 
    720725         
    721           <div class="comments"> 
    722  NAME: 
    723         read_gribtable 
    724  
    725  PURPOSE: 
    726        Read contents of a gribtable. Gribtables are located 
    727        in the gribtables subdirectory of HIPHOP 
    728     
    729  CATEGORY: 
    730         HIPHOP, GRIB, ECMWF 
    731  
    732  CALLING SEQUENCE: 
    733        read_gribtable,tablename,parmtabl=parmtabl 
    734  
    735  EXAMPLE: 
    736        tablename='ectab_128' 
    737  
    738  INPUTS: 
    739         tablename : the full path name of a gribtable file 
    740  
    741  OPTIONAL INPUT PARAMETERS: 
    742  
    743  KEYWORD INPUT PARAMETERS: 
    744  
    745  OUTPUTS: 
    746         parmtable : the parameter table 
    747  
    748  COMMON BLOCKS: 
    749  
    750  SIDE EFFECTS: 
    751  
    752  RESTRICTIONS: 
    753  
    754  PROCEDURE: 
    755          
    756  MODIFICATION HISTORY: 
    757  
    758  Dominik Brunner, Apr 2000</div> 
    759  
    760            
     726          <div class="comments"></div> 
     727 
     728          <h3>Return value</h3><div class="preformat"> 
     729 
     730</div> 
    761731 
    762732           
    … …  
    765735             
    766736            <h4 id="_read_gribtable_param_tablename">tablename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    767                
    768                
    769                
    770                
     737              <span class="attr">in</span> 
     738               
     739               
     740              <span class="attr">required</span> 
    771741               
    772742               
    … …  
    775745            </h4> 
    776746         
    777           <div class="comments"></div> 
     747          <div class="comments"> 
     748 The full path name of a gribtable file 
     749</div> 
    778750             
    779751 
    … …  
    795767            </h4> 
    796768         
    797             <div class="comments"></div> 
     769            <div class="comments"> 
     770 
     771</div> 
    798772             
    799773            <h4 id="_read_gribtable_keyword_center">center&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    808782            </h4> 
    809783         
    810             <div class="comments"></div> 
     784            <div class="comments"> 
     785 
     786</div> 
    811787             
    812788            <h4 id="_read_gribtable_keyword_subcenter">subcenter&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    821797            </h4> 
    822798         
    823             <div class="comments"></div> 
     799            <div class="comments"> 
     800 
     801</div> 
    824802             
    825803            <h4 id="_read_gribtable_keyword_tablnum">tablnum&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    834812            </h4> 
    835813         
    836             <div class="comments"></div> 
     814            <div class="comments"> 
     815 
     816</div> 
    837817             
    838818           
    839819 
    840            
    841            
    842            
    843            
    844            
    845            
    846            
    847            
    848            
    849            
    850            
    851            
    852          
    853            
    854            
    855            
    856            
    857            
    858            
    859            
    860          
     820          <h3>Examples</h3><div class="preformat"> 
     821 tablename='ectab_128' 
     822</div> 
     823          <h3>Version history</h3> 
     824           
     825          <h4>Version</h4><div class="preformat"> 
     826 $Id$</div> 
     827          <h4>History</h4><div class="preformat"> 
     828 Dominik Brunner, Apr 2000 
     829</div> 
     830           
     831           
     832          <h3>Known issues</h3> 
     833           
     834           
     835           
     836          <h4>Restrictions</h4><div class="preformat"> 
     837 
     838</div> 
     839         
     840          <h3>Other attributes</h3> 
     841           
     842           
     843          <h4>Uses routines</h4><div class="preformat"> 
     844 
     845</div> 
     846           
     847           
     848           
     849         
     850          <h3>Statistics</h3> 
     851          <table class="statistics"> 
     852            <tr><td>McCabe cyclic</td><td>           0</td></tr> 
     853            <tr><td>McCabe essential</td><td>           0</td></tr> 
     854            <tr><td>McCabe modular design</td><td>           0</td></tr> 
     855          </table> 
    861856           
    862857         

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/GRIB/scan_grib_code.html

    r157 r163  
    774774           
    775775          <h4>Version</h4><div class="preformat"> 
    776  $Id$</div> 
     776 $Id: scan_grib_code.pro 157 2006-08-21 09:01:50Z navarro $</div> 
    777777          <h4>History</h4><div class="preformat"> 
    778778  
    … …  
    796796           
    797797         
     798          <h3>Statistics</h3> 
     799          <table class="statistics"> 
     800            <tr><td>McCabe cyclic</td><td>           2</td></tr> 
     801            <tr><td>McCabe essential</td><td>           1</td></tr> 
     802            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     803          </table> 
    798804           
    799805         

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/GRIB/scan_grib_date.html

    r157 r163  
    774774           
    775775          <h4>Version</h4><div class="preformat"> 
    776  $Id$</div> 
     776 $Id: scan_grib_date.pro 157 2006-08-21 09:01:50Z navarro $</div> 
    777777          <h4>History</h4><div class="preformat"> 
    778778  
    … …  
    796796           
    797797         
     798          <h3>Statistics</h3> 
     799          <table class="statistics"> 
     800            <tr><td>McCabe cyclic</td><td>           2</td></tr> 
     801            <tr><td>McCabe essential</td><td>           1</td></tr> 
     802            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     803          </table> 
    798804           
    799805         

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/GRIB/scan_grib_messize.html

    r157 r163  
    774774           
    775775          <h4>Version</h4><div class="preformat"> 
    776  $Id$</div> 
     776 $Id: scan_grib_messize.pro 157 2006-08-21 09:01:50Z navarro $</div> 
    777777          <h4>History</h4><div class="preformat"> 
    778778  
    … …  
    796796           
    797797         
     798          <h3>Statistics</h3> 
     799          <table class="statistics"> 
     800            <tr><td>McCabe cyclic</td><td>           2</td></tr> 
     801            <tr><td>McCabe essential</td><td>           1</td></tr> 
     802            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     803          </table> 
    798804           
    799805         

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/GRIB/scan_grib_nbits.html

    r157 r163  
    774774           
    775775          <h4>Version</h4><div class="preformat"> 
    776  $Id$</div> 
     776 $Id: scan_grib_nbits.pro 157 2006-08-21 09:01:50Z navarro $</div> 
    777777          <h4>History</h4><div class="preformat"> 
    778778  
    … …  
    796796           
    797797         
     798          <h3>Statistics</h3> 
     799          <table class="statistics"> 
     800            <tr><td>McCabe cyclic</td><td>           4</td></tr> 
     801            <tr><td>McCabe essential</td><td>           1</td></tr> 
     802            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     803          </table> 
    798804           
    799805         

  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/GRIB/scan_grib_recstart.html

    r157 r163  
    759759           
    760760          <h4>Version</h4><div class="preformat"> 
    761  $Id$</div> 
     761 $Id: scan_grib_recstart.pro 157 2006-08-21 09:01:50Z navarro $</div> 
    762762          <h4>History</h4><div class="preformat"> 
    763763  
    … …  
    781781           
    782782         
     783          <h3>Statistics</h3> 
     784          <table class="statistics"> 
     785            <tr><td>McCabe cyclic</td><td>          15</td></tr> 
     786            <tr><td>McCabe essential</td><td>           8</td></tr> 
     787            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     788          </table> 
    783789           
    784790         
Note: See TracChangeset for help on using the changeset viewer.