Changeset 106 for trunk/SRC/Documentation/idldoc_html_output/ReadWrite/ncdf_timeget.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/ncdf_timeget.html (modified) (3 diffs)

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

@@ -87 +87 @@
       </div>
 
-      <div id="file_comments"></div>
+      <div id="file_comments"> get the time axis fom a netcdf_file and transforms it in
+ julian days of IDL.
+
+ the keyword parameters of ncdf_varget
+</div>
 
       
@@ -102 +106 @@
         <div class="routine_details" id="_ncdf_timeget">
 
-          <h2><a class="top" href="#container">top</a>ncdf_timeget </h2>
+          <h2><a class="top" href="#container">top</a>ncdf_timeget <span class="categories"> reading ncdf_file
+</span></h2>
         
           <p class="header">
             <span class="result">result = </span>ncdf_timeget(<span class="result"><a href="#_ncdf_timeget_param_cdfid">cdfid</a>, <a href="#_ncdf_timeget_param_timeid">timeid</a></span>, <a href="#_ncdf_timeget_keyword_YYYYMMDD">YYYYMMDD</a>=<span class="result">YYYYMMDD</span>, <a href="#_ncdf_timeget_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p>
         
-          <div class="comments">
- NAME: ncdf_timeget
-
- PURPOSE: get the time axis fom a netcdf_file and transforms it in
- julian days of IDL.
-
- CATEGORY: reading ncdf_file
-
- CALLING SEQUENCE: time = ncdf_timeget(cdfid, timeid)
- 
- INPUTS:cdfid: the ID of the ncdf_file, which is already open
-        timeid: the ID or the name of the variable which describe the calendar
-
- KEYWORD PARAMETERS:
-        /YYYYMMDD: active to obtain the date as a longinterger with
+          <div class="comments"></div>
+
+          <h3>Return value</h3><div class="value"> a long array of IDL julian days
+</div>
+
+          
+            <h3>Parameters</h3>
+        
+            
+            <h4 id="_ncdf_timeget_param_cdfid">cdfid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              <span class="attr">in</span>
+              
+              
+              <span class="attr">required</span>
+              
+              
+              
+              
+            </h4>
+        
+          <div class="comments"> the ID of the ncdf_file, which is already open</div>
+            
+            <h4 id="_ncdf_timeget_param_timeid">timeid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              <span class="attr">in</span>
+              
+              
+              <span class="attr">required</span>
+              
+              
+              
+              
+            </h4>
+        
+          <div class="comments"> the ID or the name of the variable which describe the calendar
+</div>
+            
+
+          
+
+          
+
+            <h3>Keywords</h3>
+            
+            <h4 id="_ncdf_timeget_keyword_YYYYMMDD">YYYYMMDD&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              
+              
+              
+              
+              
+              
+              
+              
+            </h4>
+        
+            <div class="comments"> active to obtain the date as a longinterger with
         the format YearYearYearYearMonthMonthDayDay
-
-        the keyword parameters of ncdf_varget
-
- OUTPUTS:a long array of IDL julian days
-
- COMMON BLOCKS:
-
- SIDE EFFECTS:
-
- RESTRICTIONS: the calendar variable must have the units attribute
- folowing the syntaxe bellow:
+</div>
+            
+            <h4 id="_ncdf_timeget_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              
+              
+              
+              
+              
+              
+              
+              
+            </h4>
+        
+            <div class="comments"></div>
+            
+          
+
+          
+          <h3>Version history</h3>
+          
+          
+          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr)
+                      June 2001</div>
+          
+          
+          <h3>Known issues</h3>
+          
+          
+          
+          <h4>Restrictions</h4><div class="value"> the calendar variable must have the units attribute
+ following the syntaxe bellow:
 
  time_counter:units = "seconds since 0001-01-01 00:00:00" ;
@@ -140 +205 @@
  time_counter:units = "months since 1979-01-01 00:00:00" ;
  time_counter:units = "years since 1979-01-01 00:00:00" ;
-
- EXAMPLE:
-</div>
-
-          
-
-          
-            <h3>Parameters</h3>
-        
-            
-            <h4 id="_ncdf_timeget_param_cdfid">cdfid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-              
-              
-              
-              
-              
-              
-              
-              
-            </h4>
-        
-          <div class="comments"></div>
-            
-            <h4 id="_ncdf_timeget_param_timeid">timeid&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-              
-              
-              
-              
-              
-              
-              
-              
-            </h4>
-        
-          <div class="comments"></div>
-            
-
-          
-
-          
-
-            <h3>Keywords</h3>
-            
-            <h4 id="_ncdf_timeget_keyword_YYYYMMDD">YYYYMMDD&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-              
-              
-              
-              
-              
-              
-              
-              
-            </h4>
-        
-            <div class="comments"></div>
-            
-            <h4 id="_ncdf_timeget_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-              
-              
-              
-              
-              
-              
-              
-              
-            </h4>
-        
-            <div class="comments"></div>
-            
-          
-
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
+</div>