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/Interpolation/get_gridparams.html

    r157 r163  
    700700 
    701701      <div id="file_comments"> 
    702  1) extract from a NetCDF file the longitude, latidude, and their dimensions 
     702 1) extract from a NetCDF file the longitude, latitude, and their dimensions 
    703703 and make sure it is 1D or 2D arrays 
    704704 
     
    739739            <h4 id="_get_gridparams_param_in1">in1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    740740              <span class="attr">in</span> 
    741               <span class="attr">out</span> 
     741               
    742742               
    743743              <span class="attr">required</span> 
     
    749749         
    750750          <div class="comments"> 
    751  the name of the netcdf file 
    752  
    753  
    754  1d or 2D arrays defining longitudes and latitudes. 
    755  
    756  
    757  the variable that will contain the longitudes 
     751 Case 1: the name of the netcdf file 
     752 Case 2: 1d or 2D arrays defining longitudes and latitudes. 
     753 Out: the variable that will contain the longitudes 
    758754</div> 
    759755             
    760756            <h4 id="_get_gridparams_param_in2">in2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    761757              <span class="attr">in</span> 
    762               <span class="attr">out</span> 
     758               
    763759               
    764760              <span class="attr">required</span> 
     
    770766         
    771767          <div class="comments"> 
    772  the name of the variable that contains the longitude in the NetCDF file 
    773  
    774  
    775  1d or 2D arrays defining longitudes and latitudes. 
    776  Note that these arrays are also outputs and can therefore be modified. 
    777  
    778  
    779  the variable that will contain the latitudes 
     768 Case 1: the name of the variable that contains the longitude in the NetCDF file 
     769 Case 2: 1d or 2D arrays defining longitudes and latitudes. 
     770         Note that these arrays are also outputs and can therefore be modified. 
     771 Out: the variable that will contain the latitudes 
    780772</div> 
    781773             
     
    792784         
    793785          <div class="comments"> 
    794  the name of the variable that contains the latitude in the NetCDF file 
    795  
    796  
    797  the number of points in the longitudinal direction 
     786 Case 1: the name of the variable that contains the latitude in the NetCDF file 
     787 Case 2: the number of points in the longitudinal direction. 
    798788</div> 
    799789             
    800790            <h4 id="_get_gridparams_param_in4">in4&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    801               <span class="attr">in</span> 
     791               
    802792              <span class="attr">out</span> 
    803793               
     
    810800         
    811801          <div class="comments"> 
    812  the number of points in the longitudinal direction 
    813  
    814  
    815  the number of points in the latitudinal direction 
     802 Case 1: the number of points in the longitudinal direction 
     803 Case 2: the number of points in the latitudinal direction 
    816804</div> 
    817805             
    818806            <h4 id="_get_gridparams_param_in5">in5&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    819               <span class="attr">in</span> 
     807               
    820808              <span class="attr">out</span> 
    821809               
     
    828816         
    829817          <div class="comments"> 
    830  the number of points in the latitudinal direction 
    831  
    832  
    833  1 or 2 to specify if lon and lat should be 1D (jpi or jpj) 
     818 Case 1: the number of points in the latitudinal direction 
     819 Case 2: 1 or 2 to specify if lon and lat should be 1D (jpi or jpj) 
    834820 arrays or 2D arrays (jpi,jpj). Note that of  n_dimensions = 1, then the 
    835821 grid must be regular (each longitudes must be the same for all latitudes 
    836  and each latitudes should be the sae for all longitudes). 
     822 and each latitudes should be the same for all longitudes). 
    837823</div> 
    838824             
     
    880866          <div class="comments"> 
    881867 1 or 2 to specify if lon and lat should be 1D (jpi or jpj) 
    882  
    883  or 
    884  
    885  2)</div> 
     868</div> 
    886869             
    887870 
     
    929912          <h3>Version history</h3> 
    930913           
    931           <h4>Version</h4><div class="preformat"> $Id: get_gridparams.pro 136 2006-07-10 15:20:19Z pinsard $ 
     914          <h4>Version</h4><div class="preformat"> $Id: get_gridparams.pro 157 2006-08-21 09:01:50Z navarro $ 
    932915</div> 
    933916          <h4>History</h4><div class="preformat"> 
     
    950933           
    951934         
     935          <h3>Statistics</h3> 
     936          <table class="statistics"> 
     937            <tr><td>McCabe cyclic</td><td>          32</td></tr> 
     938            <tr><td>McCabe essential</td><td>           1</td></tr> 
     939            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     940          </table> 
    952941           
    953942         
Note: See TracChangeset for help on using the changeset viewer.