Changeset 106 for trunk/SRC/Documentation/idldoc_html_output/ReadWrite/readbat.html

Timestamp:

06/12/06 16:49:30 (18 years ago)

Author:

pinsard

Message:

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

File:

• trunk/SRC/Documentation/idldoc_html_output/ReadWrite/readbat.html (modified) (5 diffs)

trunk/SRC/Documentation/idldoc_html_output/ReadWrite/readbat.html

@@ -87 +87 @@
       </div>
 
-      <div id="file_comments"></div>
+      <div id="file_comments"> reading the bathymetry ASCII file of OPA
+</div>
 
       
@@ -102 +103 @@
         <div class="routine_details" id="_readbat">
 
-          <h2><a class="top" href="#container">top</a>readbat </h2>
+          <h2><a class="top" href="#container">top</a>readbat <span class="categories"> for OPA
+</span></h2>
         
           <p class="header">
             <span class="result">result = </span>readbat(<span class="result"><a href="#_readbat_param_filename">filename</a></span>, <a href="#_readbat_keyword_ZERO">ZERO</a>=<span class="result">ZERO</span>)</p>
         
-          <div class="comments">
- NAME: readbat
+          <div class="comments"></div>
 
- PURPOSE: reading the bathymetry ASCII file of OPA
-
- CATEGORY: for OPA
-
- CALLING SEQUENCE: bat=readbat(filename)
- 
- INPUTS:
-    filename: a string containing the filename,  
-
- KEYWORD PARAMETERS:
-    /ZERO: to put 0 on land instead of negatives values for the islands.
-
- OUTPUTS: a 2d array
-
- COMMON BLOCKS:no
-
- SIDE EFFECTS:
-
- RESTRICTIONS:
-
- EXAMPLE:
+          <h3>Return value</h3><div class="value"> a 2d array
 </div>
-
-          
 
           
@@ -140 +119 @@
             
             <h4 id="_readbat_param_filename">filename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              <span class="attr">in</span>
               
               
-              
-              
+              <span class="attr">required</span>
               
               
@@ -150 +129 @@
             </h4>
         
-          <div class="comments"></div>
+          <div class="comments"> a string containing the filename,  
+</div>
             
 
@@ -170 +150 @@
             </h4>
         
-            <div class="comments"></div>
+            <div class="comments"> to put 0 on land instead of negatives values for the islands.
+</div>
             
           
 
           
+          <h3>Version history</h3>
           
           
-          
-          
+          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr)
+                      May 31, 2002
+    based on batlec2.pro, written by Maurice Imbard, March 17, 1998</div>