Changeset 163 for trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/GRILLE/domdef.html

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:

• trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/GRILLE/domdef.html (modified) (9 diffs)

trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/GRILLE/domdef.html

@@ -700 +700 @@
 
       <div id="file_comments"> 
- Allows to extract a subdomain of study by providing parameters 
+ Allows to extract a sub-domain of study by providing parameters 
  needed for drawings (see outputs)
 </div>
@@ -721 +721 @@
         
           <p class="header">
-            domdef<span class="result">[, <a href="#_domdef_param_x1">x1</a>][, <a href="#_domdef_param_x2">x2</a>][, <a href="#_domdef_param_y1">y1</a>][, <a href="#_domdef_param_y2">y2</a>][, <a href="#_domdef_param_z1">z1</a>][, <a href="#_domdef_param_z2">z2</a>]</span>, <a href="#_domdef_keyword_FINDALWAYS">FINDALWAYS</a>=<span class="result">FINDALWAYS</span>, <a href="#_domdef_keyword_GRIDTYPE">GRIDTYPE</a>=<span class="result">GRIDTYPE</span>, <a href="#_domdef_keyword_MEMEINDICES">MEMEINDICES</a>=<span class="result">MEMEINDICES</span>, <a href="#_domdef_keyword_XINDEX">XINDEX</a>=<span class="result">XINDEX</span>, <a href="#_domdef_keyword_YINDEX">YINDEX</a>=<span class="result">YINDEX</span>, <a href="#_domdef_keyword_ZINDEX">ZINDEX</a>=<span class="result">ZINDEX</span>, <a href="#_domdef_keyword_ENDPOINTS">ENDPOINTS</a>=<span class="result">ENDPOINTS</span>, <a href="#_domdef_keyword_TYPE">TYPE</a>=<span class="result">TYPE</span>, <a href="#_domdef_keyword_INDEX">INDEX</a>=<span class="result">INDEX</span>, <a href="#_domdef_keyword__extra">_extra</a>=<span class="result">_extra</span></p>
+            domdef<span class="result">[, <a href="#_domdef_param_x1">x1</a>][, <a href="#_domdef_param_x2">x2</a>][, <a href="#_domdef_param_y1">y1</a>][, <a href="#_domdef_param_y2">y2</a>][, <a href="#_domdef_param_z1">z1</a>][, <a href="#_domdef_param_z2">z2</a>]</span>, <a href="#_domdef_keyword_FINDALWAYS">FINDALWAYS</a>=<span class="result">FINDALWAYS</span>, <a href="#_domdef_keyword_GRIDTYPE">GRIDTYPE</a>=<span class="result">string or vector</span>, <a href="#_domdef_keyword_MEMEINDICES">MEMEINDICES</a>=<span class="result">MEMEINDICES</span>, <a href="#_domdef_keyword_XINDEX">XINDEX</a>=<span class="result">XINDEX</span>, <a href="#_domdef_keyword_YINDEX">YINDEX</a>=<span class="result">YINDEX</span>, <a href="#_domdef_keyword_ZINDEX">ZINDEX</a>=<span class="result">ZINDEX</span>, <a href="#_domdef_keyword_ENDPOINTS">ENDPOINTS</a>=<span class="result">vector</span>, <a href="#_domdef_keyword_TYPE">TYPE</a>=<span class="result">TYPE</span>, <a href="#_domdef_keyword_INDEX">INDEX</a>=<span class="result">INDEX</span>, <a href="#_domdef_keyword__extra">_extra</a>=<span class="result">_extra</span></p>
         
           <div class="comments">
@@ -851 +851 @@
               
               
-              
+              <span class="attr">type:</span> <span class="value">string or vector</span>
               
               
@@ -858 +858 @@
             <div class="comments">
  It is a string or a vector of strings containing the grids's name 
- (Only determinated by 'T','U','V','W','F') for which the calculation 
+ (Only determined by 'T','U','V','W','F') for which the calculation 
  must be done. 
-  For example: 'T' ou ['T','U']
+  For example: 'T' or ['T','U']
 </div>
             
@@ -878 +878 @@
  box which do not concern the same array indexes. This is sometimes a
  problem (or at least serious complications) in programs where several
- type of grid interven (see norme, curl...). Activate MEMEINDICE to
+ type of grid intervene (see norme, curl...). Activate MEMEINDICE to
  force domdef to take same indexes -those of the grid T- for all other
  grids.
@@ -932 +932 @@
  and concerning the X dimension refer to indexes of gdep arrays rather 
  than to values of these arrays.
-
- OUTPUTS:on recupere pour les 4 grilles t,u,v,f
-   -nxt,u,v:entier qui contient le nombre de pts en longitude de
-    la grille reduite au domaine
-   -nyt,u,v:entier qui contient le nombre de pts en latitude de
-    la grille reduite au domaine
-   -nzt,w:entier qui contient le nombre de pts en profondeur de
-    la grille reduite au domaine 3D
-   -firstxt,u,v,f: le first indice qui delimite le sous domaine
-   suivant x
-   -firstyt,u,v,f: le first indice qui delimite le sous domaine
-   suivant y
-   -firstzt,w: le first indice qui delimite le sous domaine
-   suivant z
-   -lastxt,u,v,f: le last indice qui delimite le sous domaine
-   suivant x
-   -lastyt,u,v,f: le last indice qui delimite le sous domaine
-   suivant y
-   -lastzt,w: le last indice qui delimite le sous domaine
-   suivant z
 </div>
             
@@ -960 +940 @@
               
               
-              
+              <span class="attr">type:</span> <span class="value">vector</span>
               
               
@@ -1024 +1004 @@
           
           <h4>Version</h4><div class="preformat">
- $Id: domdef.pro 142 2006-07-21 12:47:49Z navarro $
+ $Id: domdef.pro 157 2006-08-21 09:01:50Z navarro $
 </div>
           <h4>History</h4><div class="preformat">
@@ -1050 +1030 @@
           
         
+          <h3>Statistics</h3>
+          <table class="statistics">
+            <tr><td>McCabe cyclic</td><td>         206</td></tr>
+            <tr><td>McCabe essential</td><td>           2</td></tr>
+            <tr><td>McCabe modular design</td><td>           1</td></tr>
+          </table>