Ignore:
Timestamp:
06/12/06 10:29:56 (18 years ago)
Author:
pinsard
Message:

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

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/SRC/Documentation/idldoc_html_output/Interpolation/angle.html

    r89 r101  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
     89      <div id="file_comments"> north stereographic polar projection 
     90 
     91 Compute angles between grid lines and direction of the North 
     92(fom angle.F,v 2.2 in OPA8.2) 
     93</div> 
    9094 
    9195       
     
    102106           
    103107          <dt><p><a href="#_fsnspp"><span class="result">result = </span>fsnspp(<span class="result">plam, pphi</span>, DOUBLE=<span class="result">DOUBLE</span>)</a></p><dt> 
    104           <dd>  NAME:angle.</dd>         
     108          <dd></dd>      
    105109           
    106110          <dt><p><a href="#_angle">angle<span class="result">, fileocemesh, gcosu, gsinu, gcosv, gsinv, gcost, gsint</span>, IODIRECTORY=<span class="result">IODIRECTORY</span>, DOUBLE=<span class="result">DOUBLE</span></a></p><dt> 
     
    121125            <span class="result">result = </span>fsnspp(<span class="result"><a href="#_fsnspp_param_plam">plam</a>, <a href="#_fsnspp_param_pphi">pphi</a></span>, <a href="#_fsnspp_keyword_DOUBLE">DOUBLE</a>=<span class="result">DOUBLE</span>)</p> 
    122126         
    123           <div class="comments"> 
    124  NAME:angle.pro (fom angle.F,v 2.2 in OPA8.2) 
    125  
    126  PURPOSE:Compute angles between grid lines and direction of the North 
    127  
    128  CALLING SEQUENCE:  
    129      angle, fileocemesh, gcosu, gsinu, gcosv, gsinv, gcost, gsint 
    130  
    131  INPUTS: 
    132      fileocemesh a netcdf file that contains (at least): 
    133         glamu, gphiu: longitudes and latitudes at U-points 
    134         glamv, gphiv: longitudes and latitudes at V-points 
    135         glamf, gphif: longitudes and latitudes at F-points 
    136  
    137  KEYWORD PARAMETERS: 
    138  
    139     IODIRECTORY: the directory path where is located fileocemesh 
    140  
    141     /DOUBLE: use double precision (default is float) 
    142  
    143  OUTPUTS: 
     127          <div class="comments"></div> 
     128 
     129          <h3>Return value</h3><div class="value"> 
    144130       gsinu,gcosu : sinus and cosinus of the angle  
    145131       gsinv,gcosv   between north-south direction  
    146132       gsint,gcost   and the j-direction of the mesh 
    147                        
    148  
    149  RESTRICTIONS: to compute the lateral boundary conditions, we assume 
     133</div> 
     134 
     135           
     136            <h3>Parameters</h3> 
     137         
     138             
     139            <h4 id="_fsnspp_param_plam">plam&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     140               
     141               
     142               
     143               
     144               
     145               
     146               
     147               
     148            </h4> 
     149         
     150          <div class="comments"></div> 
     151             
     152            <h4 id="_fsnspp_param_pphi">pphi&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     153               
     154               
     155               
     156               
     157               
     158               
     159               
     160               
     161            </h4> 
     162         
     163          <div class="comments"></div> 
     164             
     165 
     166           
     167 
     168           
     169 
     170            <h3>Keywords</h3> 
     171             
     172            <h4 id="_fsnspp_keyword_DOUBLE">DOUBLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     173               
     174               
     175               
     176               
     177               
     178               
     179               
     180               
     181            </h4> 
     182         
     183            <div class="comments"> use double precision (default is float) 
     184</div> 
     185             
     186           
     187 
     188           
     189          <h3>Version history</h3> 
     190           
     191           
     192          <h4>History</h4><div class="value"> 
     193   -------------- 
     194       Original :  96-07 (O. Marti) 
     195                   98-06 (G. Madec) 
     196       Feb 2005: IDL adaptation S. Masson </div> 
     197           
     198           
     199          <h3>Known issues</h3> 
     200           
     201           
     202           
     203          <h4>Restrictions</h4><div class="value"> to compute the lateral boundary conditions, we assume 
    150204 that:  
    151205     (1) the first line is similar to the second line 
     
    157211       =>    gsinv[0, *] = gsinv[jpj-2, *] 
    158212 
    159  
    160  MODIFICATION HISTORY: 
    161    -------------- 
    162        Original :  96-07 (O. Marti) 
    163                    98-06 (G. Madec) 
    164        Feb 2005: IDL adaptation S. Masson </div> 
    165  
    166            
    167  
    168            
    169             <h3>Parameters</h3> 
    170          
    171              
    172             <h4 id="_fsnspp_param_plam">plam&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    173                
    174                
    175                
    176                
    177                
    178                
    179                
    180                
    181             </h4> 
    182          
    183           <div class="comments"></div> 
    184              
    185             <h4 id="_fsnspp_param_pphi">pphi&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    186                
    187                
    188                
    189                
    190                
    191                
    192                
    193                
    194             </h4> 
    195          
    196           <div class="comments"></div> 
    197              
    198  
    199            
    200  
    201            
    202  
    203             <h3>Keywords</h3> 
    204              
    205             <h4 id="_fsnspp_keyword_DOUBLE">DOUBLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    206                
    207                
    208                
    209                
    210                
    211                
    212                
    213                
    214             </h4> 
    215          
    216             <div class="comments"></div> 
    217              
    218            
    219  
    220            
    221            
    222            
    223            
    224            
    225            
    226            
    227            
    228            
    229            
    230            
    231            
     213</div> 
    232214         
    233215           
     
    260242             
    261243            <h4 id="_angle_param_fileocemesh">fileocemesh&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    262                
    263                
    264                
    265                
    266                
    267                
    268                
    269                
    270             </h4> 
    271          
    272           <div class="comments"></div> 
     244              <span class="attr">in</span> 
     245               
     246               
     247              <span class="attr">required</span> 
     248               
     249               
     250               
     251               
     252            </h4> 
     253         
     254          <div class="comments"> a netcdf file that contains (at least): 
     255        glamu, gphiu: longitudes and latitudes at U-points 
     256        glamv, gphiv: longitudes and latitudes at V-points 
     257        glamf, gphif: longitudes and latitudes at F-points 
     258</div> 
    273259             
    274260            <h4 id="_angle_param_gcosu">gcosu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    368354            </h4> 
    369355         
    370             <div class="comments"></div> 
     356            <div class="comments"> the directory path where is located fileocemesh</div> 
    371357             
    372358            <h4 id="_angle_keyword_DOUBLE">DOUBLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    381367            </h4> 
    382368         
    383             <div class="comments"></div> 
     369            <div class="comments"> use double precision (default is float)</div> 
    384370             
    385371           
Note: See TracChangeset for help on using the changeset viewer.