Changeset 163 for trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/TRIANGULATION/triangule.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/TRIANGULATION/triangule.html (modified) (8 diffs)

trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/TRIANGULATION/triangule.html

@@ -699 +699 @@
       </div>
 
-      <div id="file_comments"></div>
+      <div id="file_comments">
+
+</div>
 
       
@@ -714 +716 @@
         <div class="routine_details" id="_triangule">
 
-          <h2><a class="top" href="#container">top</a>triangule </h2>
+          <h2><a class="top" href="#container">top</a>triangule <span class="categories">
+
+</span></h2>
         
           <p class="header">
-            <span class="result">result = </span>triangule(<span class="result"><a href="#_triangule_param_maskentree">maskentree</a></span>, <a href="#_triangule_keyword_BASIC">BASIC</a>=<span class="result">BASIC</span>, <a href="#_triangule_keyword_COINMONTE">COINMONTE</a>=<span class="result">COINMONTE</span>, <a href="#_triangule_keyword_COINDESCEND">COINDESCEND</a>=<span class="result">COINDESCEND</span>, <a href="#_triangule_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p>
-        
-          <div class="comments">
-</div>
-
-          
+            <span class="result">result = </span>triangule(<span class="result">[<a href="#_triangule_param_maskentree">maskentree</a>]</span>, <a href="#_triangule_keyword_BASIC">BASIC</a>=<span class="result">BASIC</span>, <a href="#_triangule_keyword_COINMONTE">COINMONTE</a>=<span class="result">array</span>, <a href="#_triangule_keyword_COINDESCEND">COINDESCEND</a>=<span class="result">array</span>, <a href="#_triangule_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p>
+        
+          <div class="comments"></div>
+
+          <h3>Return value</h3><div class="preformat">
+
+</div>
 
           
@@ -729 +734 @@
             
             <h4 id="_triangule_param_maskentree">maskentree&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-              
-              
-              
-              
-              
-              
+              <span class="attr">in</span>
+              
+              <span class="attr">optional</span>
+              
+              
+              <span class="attr">type:</span> <span class="value">2d array</span>
               
               
             </h4>
         
-          <div class="comments"></div>
+          <div class="comments">
+ It is a 2d array which will serve to mask the field we will trace after with CONTOUR, 
+ ...TRIANGULATION=triangule(mask)
+ If this argument is not specified, the function use tmask
+</div>
             
 
@@ -759 +768 @@
             </h4>
         
-            <div class="comments"></div>
+            <div class="comments">
+ Specify that the mask is on a basic grid (use the triangulation for vertical cuts and hovmoellers)
+</div>
             
             <h4 id="_triangule_keyword_COINMONTE">COINMONTE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
@@ -767 +778 @@
               
               
-              
+              <span class="attr">type:</span> <span class="value">array</span>
               
               
             </h4>
         
-            <div class="comments"></div>
+            <div class="comments">
+ To obtain the array of "ascending land corner" to be treated with 
+ completecointerre.pro in the variable array instead of make it pass by the global 
+ variable twin_corners_up.
+</div>
             
             <h4 id="_triangule_keyword_COINDESCEND">COINDESCEND&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
@@ -780 +795 @@
               
               
-              
+              <span class="attr">type:</span> <span class="value">array</span>
               
               
             </h4>
         
-            <div class="comments"></div>
+            <div class="comments">
+ See COINMONTE
+</div>
             
             <h4 id="_triangule_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
@@ -798 +815 @@
             </h4>
         
-            <div class="comments"></div>
+            <div class="comments">
+ Used to pass your keywords
+</div>
             
           
 
-          
-          
-          
-          
-          
+          <h3>Examples</h3><div class="preformat">
+
+</div>
+          <h3>Version history</h3>
+          
+          <h4>Version</h4><div class="preformat">
+ $Id$
+</div>
+          <h4>History</h4><div class="preformat">
+
+</div>
           
           
@@ -815 +840 @@
  seb
 </div>
-          
-        
-          
-          
-          
-          
-          
-          
-          
-        
+          <h4>Restrictions</h4><div class="preformat">
+
+</div>
+        
+          <h3>Other attributes</h3>
+          
+          
+          <h4>Uses routines</h4><div class="preformat">
+
+</div>
+          
+          
+          
+        
+          <h3>Statistics</h3>
+          <table class="statistics">
+            <tr><td>McCabe cyclic</td><td>          10</td></tr>
+            <tr><td>McCabe essential</td><td>           1</td></tr>
+            <tr><td>McCabe modular design</td><td>           1</td></tr>
+          </table>