Ignore:
Timestamp:
06/29/06 16:59:33 (18 years ago)
Author:
pinsard
Message:

correction of some *.pro using aspell list; introduction of default idldoc syntax

Location:
trunk/SRC/Documentation/idldoc_html_output/Grid
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • trunk/SRC/Documentation/idldoc_html_output/Grid/computegrid.html

    r119 r121  
    935935            </h4> 
    936936         
    937             <div class="comments"> a 2 elements vector, [lon1,lon2], the longitute 
     937            <div class="comments"> a 2 elements vector, [lon1,lon2], the longitude 
    938938       boundaries that should be used to visualize the data. 
    939939       we must have lon2 > lon1 and lon2 - lon1 le 360 
     
    950950               
    951951               
    952                
     952              <span class="attr">default:</span> <span class="value">0L</span> 
     953               
     954            </h4> 
     955         
     956            <div class="comments"></div> 
     957             
     958            <h4 id="_computegrid_keyword_XMAXMESH">XMAXMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     959               
     960               
     961               
     962               
     963               
     964               
     965              <span class="attr">default:</span> <span class="value">jpiglo-1</span> 
     966               
     967            </h4> 
     968         
     969            <div class="comments"></div> 
     970             
     971            <h4 id="_computegrid_keyword_YMINMESH">YMINMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     972               
     973               
     974               
     975               
     976               
     977               
     978              <span class="attr">default:</span> <span class="value">0L</span> 
    953979               
    954980            </h4> 
     
    956982            <div class="comments"> </div> 
    957983             
    958             <h4 id="_computegrid_keyword_XMAXMESH">XMAXMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    959                
    960                
    961                
    962                
    963                
    964                
    965                
    966                
    967             </h4> 
    968          
    969             <div class="comments"> </div> 
    970              
    971             <h4 id="_computegrid_keyword_YMINMESH">YMINMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    972                
    973                
    974                
    975                
    976                
    977                
    978                
    979                
    980             </h4> 
    981          
    982             <div class="comments"> </div> 
    983              
    984984            <h4 id="_computegrid_keyword_YMAXMESH">YMAXMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    985985               
     
    989989               
    990990               
    991                
    992                
    993             </h4> 
    994          
    995             <div class="comments"> </div> 
     991              <span class="attr">default:</span> <span class="value">jpjglo-1</span> 
     992               
     993            </h4> 
     994         
     995            <div class="comments"></div> 
    996996             
    997997            <h4 id="_computegrid_keyword_ZMINMESH">ZMINMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    10021002               
    10031003               
    1004                
     1004              <span class="attr">default:</span> <span class="value">0L</span> 
    10051005               
    10061006            </h4> 
     
    10091009       to define the common variables i[xyz]minmesh 
    10101010       used to define the grid only in a zoomed part of the original 
    1011        grid. Defaut values are 0L, max value is [XYZ]MAXMESH 
     1011       grid. max value is [XYZ]MAXMESH 
    10121012</div> 
    10131013             
     
    10191019               
    10201020               
    1021                
    1022                
    1023             </h4> 
    1024          
    1025             <div class="comments">  
     1021              <span class="attr">default:</span> <span class="value">jpkglo-1</span> 
     1022               
     1023            </h4> 
     1024         
     1025            <div class="comments"> 
    10261026       to define the common variables i[xyz]maxmesh 
    10271027       used to define the grid only in a zoomed part of the original 
    1028        grid. Defaut values are jp[ijk]glo-1, max value is 
    1029        jp[ijk]glo-1. if [XYZ]MAXMESH is negative, then we define 
    1030        i[xyz]maxmesh as jp[ijk]glo - 1 + [XYZ]MAXMESH instead of 
    1031        [XYZ]MAXMESH      
     1028       grid. max value is jp[ijk]glo-1.  
     1029       if [XYZ]MAXMESH is negative, then we define i[xyz]maxmesh as  
     1030       jp[ijk]glo - 1 + [XYZ]MAXMESH instead of [XYZ]MAXMESH     
    10321031</div> 
    10331032             
     
    10951094         
    10961095            <div class="comments"> = scalar to force the manual definition of key_shift. By 
    1097        debault, key_shift is automaticaly computed according to 
     1096       default, key_shift is automaticaly computed according to 
    10981097       glamboundary (when defined) by using the FIRST LINE of glamt. if 
    10991098       key_periodic=0 then in any case key_shift = 0.  
     
    11071106               
    11081107               
    1109                
    1110                
    1111             </h4> 
    1112          
    1113             <div class="comments">  a 3 elements vector to specify the stride in x, y, z 
    1114        direction. Default definition is [1, 1, 1]. The resulting value 
     1108              <span class="attr">default:</span> <span class="value">[1, 1, 1]</span> 
     1109               
     1110            </h4> 
     1111         
     1112            <div class="comments"> a 3 elements vector to specify the stride in x, y, z 
     1113       direction. The resulting value 
    11151114       will be stored in the common (cm_4mesh) variable key_stride 
    11161115</div> 
  • trunk/SRC/Documentation/idldoc_html_output/Grid/ncdf_meshread.html

    r119 r121  
    734734               
    735735               
    736                
     736              <span class="attr">default:</span> <span class="value">meshmask.nc</span> 
    737737               
    738738            </h4> 
    739739         
    740           <div class="comments"> the name of the meshmask file to read. Default is 
    741     meshmask.nc. if this name does not contain any / and if 
     740          <div class="comments">  
     741    the name of the meshmask file to read.  
     742    if this name does not contain any "/" and if 
    742743    iodirectory keyword is not specify, then the common variable 
    743744    iodir will be use to define the mesh file path. 
     
    762763            </h4> 
    763764         
    764             <div class="comments"> a 2 elements vector, {lon1,lon2], the longitute 
     765            <div class="comments"> a 2 elements vector, [lon1,lon2], the longitude 
    765766    boundaries that should be used to visualize the data. 
    766767      lon2 > lon1 
     
    843844            </h4> 
    844845         
    845             <div class="comments">  to force the manual definition of key_shift. By 
    846     debault, key_shift is automaticaly computed according to the 
     846            <div class="comments"> to force the manual definition of key_shift. By 
     847    default, key_shift is automaticaly computed according to the 
    847848    glamboundary (when defined) by using the first line of glamt. if 
    848     key_periodic=0 then in any case key_shift = 0.  
     849    key_periodic=0 then in any case key_shift = 0. 
    849850</div> 
    850851             
     
    856857               
    857858               
    858                
     859              <span class="attr">default:</span> <span class="value">key_stride</span> 
    859860               
    860861            </h4> 
    861862         
    862             <div class="comments"> a 3 elements vector to specify the stride in x, y, z 
    863     direction. Default definition is key_stride. The resulting value 
    864     will be stored in the common (cm_4mesh) variable key_stride 
    865  
     863            <div class="comments">  
     864    a 3 elements vector to specify the stride in x, y, z direction.  
     865    The resulting value will be stored in the common (cm_4mesh) variable  
     866    key_stride 
    866867</div> 
    867868             
     
    893894         
    894895            <div class="comments"> used to pass your keywords to the created function. 
    895  
    896896</div> 
    897897             
     
    900900          <h3>Examples</h3><div class="value"> 
    901901 IDL> ncdf_meshread [,' filename'] 
    902  </div> 
     902</div> 
    903903          <h3>Version history</h3> 
    904904           
     
    911911 of key_shift, ...) 
    912912 Oct. 2004, Sebastien Masson: add PERIODIC and SHIFT 
    913  Aug. 2005, Sebastien Masson: some cleaning + english  
     913 Aug. 2005, Sebastien Masson: some cleaning + english 
    914914</div> 
    915915           
     
    919919           
    920920           
    921           <h4>Restrictions</h4><div class="value"> define and/or use common variables from  
     921          <h4>Restrictions</h4><div class="value"> define and/or use common variables from 
    922922               cm_4mesh, cm_4data, cm_4cal 
    923923 
     
    926926  ixminmesh,ixmaxmesh,iyminmesh,iymaxmesh,izminmesh,izmaxmesh must 
    927927  be defined febore calling ncdf_meshread. if some of those value 
    928   are equal to -1 they will be automatically defined  
     928  are equal to -1 they will be automatically defined 
    929929</div> 
    930930         
  • trunk/SRC/Documentation/idldoc_html_output/Grid/smallmeshmask.html

    r119 r121  
    875875               
    876876               
    877                
     877              <span class="attr">default:</span> <span class="value">smallmeshmask.nc</span> 
    878878               
    879879            </h4> 
    880880         
    881           <div class="comments"> the name of the reduced meshmask file. default 
    882       definition is smallmeshmask.nc 
     881          <div class="comments">  
     882      the name of the reduced meshmask file.  
    883883</div> 
    884884             
Note: See TracChangeset for help on using the changeset viewer.