Ignore:
Timestamp:
06/12/06 16:49:30 (18 years ago)
Author:
pinsard
Message:

start to modify headers of ReadWrite? *.pro files for better idldoc output

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Documentation/idldoc_html_output/ReadWrite/readoldopadistcoast.html

    r104 r106  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
     89      <div id="file_comments"> 
     90      read the old binary direct access file that contains the 
     91      distance to the coast in OPA. 
     92      based on the OPA subroutines dtacof and parctl 
     93</div> 
    9094 
    9195       
    … …  
    102106           
    103107          <dt><p><a href="#_read3fromopa"><span class="result">result = </span>read3fromopa(<span class="result">unit, params, num</span>)</a></p><dt> 
    104           <dd>  NAME:readoldopadistcoast   PURPOSE:       read the old binary direct access file that contains the       distance to the coast in OPA.</dd>      
     108          <dd></dd>      
    105109           
    106110          <dt><p><a href="#_readoldopadistcoast"><span class="result">result = </span>readoldopadistcoast(<span class="result">filename, jpiglo, jpjglo, jpk</span>, IBLOC=<span class="result">IBLOC</span>, JPBYT=<span class="result">JPBYT</span>, NUMREC=<span class="result">NUMREC</span>)</a></p><dt> 
    … …  
    116120        <div class="routine_details" id="_read3fromopa"> 
    117121 
    118           <h2><a class="top" href="#container">top</a>read3fromopa </h2> 
     122          <h2><a class="top" href="#container">top</a>read3fromopa <span class="categories"> for OPA before NetCDF 
     123 
     124</span></h2> 
    119125         
    120126          <p class="header"> 
    121127            <span class="result">result = </span>read3fromopa(<span class="result"><a href="#_read3fromopa_param_unit">unit</a>, <a href="#_read3fromopa_param_params">params</a>, <a href="#_read3fromopa_param_num">num</a></span>)</p> 
    122128         
    123           <div class="comments"> 
    124  NAME:readoldopadistcoast 
    125  
    126  PURPOSE: 
    127       read the old binary direct access file that contains the 
    128       distance to the coast in OPA. 
    129       based on the OPA subroutines dtacof and parctl 
    130  
    131  CATEGORY:for OPA before NetCDF 
    132  
    133  CALLING SEQUENCE:res=readoldopadistcoast(filename) 
    134  
    135  INPUTS: 
    136       filename (with the whole path if necessary) 
    137      jpiglo, jpjglo, jpk: dimensions of the opa grid 
    138  
    139  KEYWORD PARAMETERS: 
    140      IBLOC: ibloc size, default: ibloc = 4096L 
    141      JPBYT: jpbyt size, defalut: jpbyt = 8L 
    142      NUMREC: number of records in the file. defalut: numrec = 19L*jpk 
    143  
    144  OUTPUTS: a structure that contains two elements: tdistcoast (the 
     129          <div class="comments"></div> 
     130 
     131          <h3>Return value</h3><div class="value">  a structure that contains two elements: tdistcoast (the 
    145132 distance for the t-points) and fdiscoast (the distance for the 
    146133 f-points). 
    147  
    148  COMMON BLOCKS: no 
    149  
    150  SIDE EFFECTS: 
    151  
    152  RESTRICTIONS: 
    153  
    154  EXAMPLE: 
    155 </div> 
    156  
    157            
     134</div> 
    158135 
    159136           
    … …  
    206183 
    207184           
    208            
    209            
    210            
    211            
     185          <h3>Version history</h3> 
     186           
     187           
     188          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     189                      June, 2002</div> 
    212190           
    213191           
    … …  
    247225             
    248226            <h4 id="_readoldopadistcoast_param_filename">filename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    249                
    250                
    251                
    252                
    253                
    254                
    255                
    256                
    257             </h4> 
    258          
    259           <div class="comments"></div> 
     227              <span class="attr">in</span> 
     228               
     229               
     230              <span class="attr">required</span> 
     231               
     232               
     233               
     234               
     235            </h4> 
     236         
     237          <div class="comments"> filename (with the whole path if necessary)</div> 
    260238             
    261239            <h4 id="_readoldopadistcoast_param_jpiglo">jpiglo&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    262                
    263                
    264                
    265                
     240              <span class="attr">in</span> 
     241               
     242               
     243              <span class="attr">required</span> 
    266244               
    267245               
    … …  
    273251             
    274252            <h4 id="_readoldopadistcoast_param_jpjglo">jpjglo&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    275                
    276                
    277                
    278                
     253              <span class="attr">in</span> 
     254               
     255               
     256              <span class="attr">required</span> 
    279257               
    280258               
    … …  
    286264             
    287265            <h4 id="_readoldopadistcoast_param_jpk">jpk&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    288                
    289                
    290                
    291                
    292                
    293                
    294                
    295                
    296             </h4> 
    297          
    298           <div class="comments"></div> 
     266              <span class="attr">in</span> 
     267               
     268               
     269              <span class="attr">required</span> 
     270               
     271               
     272               
     273               
     274            </h4> 
     275         
     276          <div class="comments"> 
     277      dimensions of the opa grid</div> 
    299278             
    300279 
    … …  
    316295            </h4> 
    317296         
    318             <div class="comments"></div> 
     297            <div class="comments"> ibloc size, default: ibloc = 4096L</div> 
    319298             
    320299            <h4 id="_readoldopadistcoast_keyword_JPBYT">JPBYT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    329308            </h4> 
    330309         
    331             <div class="comments"></div> 
     310            <div class="comments"> jpbyt size, default: jpbyt = 8L</div> 
    332311             
    333312            <h4 id="_readoldopadistcoast_keyword_NUMREC">NUMREC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    342321            </h4> 
    343322         
    344             <div class="comments"></div> 
    345              
    346            
    347  
    348            
    349            
    350            
    351            
    352            
     323            <div class="comments"> number of records in the file. default: numrec = 19L*jpk</div> 
     324             
     325           
     326 
     327           
     328          <h3>Version history</h3> 
     329           
     330           
     331          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     332                      June, 2002</div> 
    353333           
    354334           
Note: See TracChangeset for help on using the changeset viewer.