Changeset 402 for trunk/SRC/Documentation/idldoc_html_output/ReadWrite/ncdf_gettime.html

Timestamp:

07/23/09 11:18:49 (15 years ago)

Author:

smasson

Message:

update documentation

File:

• trunk/SRC/Documentation/idldoc_html_output/ReadWrite/ncdf_gettime.html (modified) (8 diffs)

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

@@ -110 +110 @@
         
           <p class="header">
-            <span class="result">result = </span>ncdf_gettime(<span class="result"><a href="#_ncdf_gettime_param_filename">filename</a>, <a href="#_ncdf_gettime_param_cdfid">cdfid</a></span>, <a href="#_ncdf_gettime_keyword_TIMEVAR">TIMEVAR</a>=<span class="result">string</span>, <a href="#_ncdf_gettime_keyword_CALLER">CALLER</a>=<span class="result">scalar</span>, <a href="#_ncdf_gettime_keyword_ERR">ERR</a>=<span class="result">ERR</span>, <a href="#_ncdf_gettime_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
+            <span class="result">result = </span>ncdf_gettime(<span class="result"><a href="#_ncdf_gettime_param_filename">filename</a>[, <a href="#_ncdf_gettime_param_cdfid">cdfid</a>]</span>, <a href="#_ncdf_gettime_keyword_CALTYPE">CALTYPE</a>=<span class="result">CALTYPE</span>, <a href="#_ncdf_gettime_keyword_TIMEVAR">TIMEVAR</a>=<span class="result">string</span>, <a href="#_ncdf_gettime_keyword_CALLER">CALLER</a>=<span class="result">string</span>, <a href="#_ncdf_gettime_keyword_ERR">ERR</a>=<span class="result">ERR</span>, <a href="#_ncdf_gettime_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
         
           <div class="comments">
@@ -143 +143 @@
               <span class="attr">in</span>
               
-              
-              <span class="attr">required</span>
+              <span class="attr">optional</span>
+              
               
               <span class="attr">type:</span> <span class="value">scalar</span>
@@ -152 +152 @@
         
           <div class="comments">
- the ID of the ncdf_file, which is already open
+ the ID of the ncdf_file, if the file is already open. 
+ if not provided, ncdf_gettime open the file defined by filename
 </div>
             
@@ -161 +162 @@
 
             <h3>Keywords</h3>
+            
+            <h4 id="_ncdf_gettime_keyword_CALTYPE">CALTYPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              
+              
+              
+              
+              
+              
+              
+              
+            </h4>
+        
+            <div class="comments">
+ Used to specify (or orverwrite) the type of calendar that should be
+ used. We accept only 'noleap', '360d', 'greg' and 'gregorian'. By
+ default, we use the type of calendar defied in the attibute
+ calendar. if not, we define it as gregorian.
+</div>
             
             <h4 id="_ncdf_gettime_keyword_TIMEVAR">TIMEVAR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
@@ -186 +205 @@
               <span class="attr">required</span>
               
-              <span class="attr">type:</span> <span class="value">scalar</span>
+              <span class="attr">type:</span> <span class="value">string</span>
               
               
@@ -193 +212 @@
             <div class="comments">
  Used to specify the error messages. Give the name of the calling
- procedure. It can be only 'read_ncdf' or 'scanfile'.
+ procedure. It can be only '<a href="..//ToBeReviewed/LECTURE/read_ncdf.html">read_ncdf</a>' or '<a href="..//ToBeReviewed/WIDGET/AUTOUR_de_XXX/scanfile.html">scanfile</a>'.
+
 </div>
             
@@ -233 +253 @@
           
           <h4>Version</h4><div class="preformat">
- $Id: ncdf_gettime.pro 358 2008-04-28 09:41:14Z pinsard $</div>
+ $Id: ncdf_gettime.pro 401 2009-07-23 08:48:16Z smasson $</div>
           <h4>History</h4><div class="preformat">
  August 2007: Sebastien Masson (smasson@lodyc.jussieu.fr)
@@ -264 +284 @@
           <h3>Statistics</h3>
           <table class="statistics">
-            <tr><td>McCabe cyclic</td><td>          39</td></tr>
+            <tr><td>McCabe cyclic</td><td>          51</td></tr>
             <tr><td>McCabe essential</td><td>           1</td></tr>
             <tr><td>McCabe modular design</td><td>           1</td></tr>