Changeset 93 for trunk/SRC/Documentation/idldoc_html_output/Utilities/isadirectory.html

Timestamp:

06/07/06 19:12:14 (18 years ago)

Author:

pinsard

Message:

start to modify headers of Calendar and Utilities *.pro files for bet
ter idldoc output

File:

• trunk/SRC/Documentation/idldoc_html_output/Utilities/isadirectory.html (modified) (3 diffs)

trunk/SRC/Documentation/idldoc_html_output/Utilities/isadirectory.html

@@ -87 +87 @@
       </div>
 
-      <div id="file_comments"></div>
+      <div id="file_comments">  all dialog_pickfile keywords (like filter) can be used.
+</div>
 
       
@@ -102 +103 @@
         <div class="routine_details" id="_isadirectory">
 
-          <h2><a class="top" href="#container">top</a>isadirectory </h2>
+          <h2><a class="top" href="#container">top</a>isadirectory <span class="categories"> io
+</span></h2>
         
           <p class="header">
-            <span class="result">result = </span>isadirectory(<span class="result"><a href="#_isadirectory_param_directoryin">directoryin</a></span>, <a href="#_isadirectory_keyword_TITLE">TITLE</a>=<span class="result">TITLE</span>, <a href="#_isadirectory_keyword_IODIRECTORY">IODIRECTORY</a>=<span class="result">IODIRECTORY</span>, <a href="#_isadirectory_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p>
+            <span class="result">result = </span>isadirectory(<span class="result">[<a href="#_isadirectory_param_directoryin">directoryin</a>]</span>, <a href="#_isadirectory_keyword_TITLE">TITLE</a>=<span class="result">TITLE</span>, <a href="#_isadirectory_keyword_IODIRECTORY">IODIRECTORY</a>=<span class="result">IODIRECTORY</span>, <a href="#_isadirectory_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p>
         
           <div class="comments">
- NAME:isadirectory
-
- PURPOSE:check if a directory exists and make sure that it ends 
+ check if a directory exists and make sure that it ends 
          with the directory separator mark.
-
- CATEGORY: io
-
- CALLING SEQUENCE: directory=isadirectory([dirname])
- 
- INPUTS:optional:a proposed directory. If neither dirname 
+</div>
+
+          <h3>Return value</h3><div class="value"> the directory name
+</div>
+
+          
+            <h3>Parameters</h3>
+        
+            
+            <h4 id="_isadirectory_param_directoryin">directoryin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              <span class="attr">in</span>
+              
+              <span class="attr">optional</span>
+              
+              
+              
+              
+              
+            </h4>
+        
+          <div class="comments"> a proposed directory. If neither dirname 
         input parameter of IODIRECTORY keyword are defined,
         the ask the user to choose a directory.
-
- KEYWORD PARAMETERS:
-
-     IODIRECTORY:a proposed directory
-
-     TITLE = the title of the window
-
-     all dialog_pickfile keywords (like filter)
-
- OUTPUTS: the directory name
-
- COMMON BLOCKS:none
-
- SIDE EFFECTS:
-
- RESTRICTIONS:
-
- EXAMPLE:
+</div>
+            
+
+          
+
+          
+
+            <h3>Keywords</h3>
+            
+            <h4 id="_isadirectory_keyword_TITLE">TITLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              
+              
+              
+              
+              
+              
+              
+              
+            </h4>
+        
+            <div class="comments"> the title of the window
+</div>
+            
+            <h4 id="_isadirectory_keyword_IODIRECTORY">IODIRECTORY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              
+              
+              
+              
+              
+              
+              
+              
+            </h4>
+        
+            <div class="comments"> a proposed directory
+</div>
+            
+            <h4 id="_isadirectory_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              
+              
+              
+              
+              
+              
+              
+              
+            </h4>
+        
+            <div class="comments"></div>
+            
+          
+
+          <h3>Examples</h3><div class="value"> 
 
     IDL> print, !dir
@@ -145 +195 @@
     IDL> print, isadirectory(!dir+'notgood')
 </div>
-
-          
-
-          
-            <h3>Parameters</h3>
-        
-            
-            <h4 id="_isadirectory_param_directoryin">directoryin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-              
-              
-              
-              
-              
-              
-              
-              
-            </h4>
-        
-          <div class="comments"></div>
-            
-
-          
-
-          
-
-            <h3>Keywords</h3>
-            
-            <h4 id="_isadirectory_keyword_TITLE">TITLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-              
-              
-              
-              
-              
-              
-              
-              
-            </h4>
-        
-            <div class="comments"></div>
-            
-            <h4 id="_isadirectory_keyword_IODIRECTORY">IODIRECTORY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-              
-              
-              
-              
-              
-              
-              
-              
-            </h4>
-        
-            <div class="comments"></div>
-            
-            <h4 id="_isadirectory_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 28, 2000
+ June 2005: Sebastien Masson: cleaning, use for file_* functions</div>