Changeset 93 for trunk/SRC/Documentation/idldoc_html_output/Utilities/createfunc.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/createfunc.html (modified) (1 diff)

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

@@ -108 +108 @@
         
           <div class="comments">
- NAME:createfunc
-
- PURPOSE: write an idl function, compile it and execute it.
-          usefull to avoid the use of execute
-
- CATEGORY:
-
- CALLING SEQUENCE:res = createfunc(command)
- 
- INPUTS:
-      command: a scalar string defining the result to be byven back by the
-               function. (see examples)
-
- KEYWORD PARAMETERS:
-
-      FILENAMEIN: name of the funccedure to be created.
-      'for_createfunc.pro' by default
-
-      KWDLIST: a vector string. to specify a list of keywords that
+ write an idl function, compile it and execute it.
+ usefull to avoid the use of execute
+</div>
+
+          
+
+          
+            <h3>Parameters</h3>
+        
+            
+            <h4 id="_createfunc_param_command">command&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              <span class="attr">in</span>
+              
+              
+              <span class="attr">required</span>
+              
+              
+              
+              
+            </h4>
+        
+          <div class="comments"> a scalar string defining the result to be byven back by the function. (see examples)
+</div>
+            
+
+          
+
+          
+
+            <h3>Keywords</h3>
+            
+            <h4 id="_createfunc_keyword_FILENAMEIN">FILENAMEIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              <span class="attr">in</span>
+              
+              
+              
+              
+              
+              
+              
+            </h4>
+        
+            <div class="comments"> name of the funccedure to be created.
+      'for_createfunc.pro' by default</div>
+            
+            <h4 id="_createfunc_keyword_KWDLIST">KWDLIST&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              <span class="attr">in</span>
+              
+              
+              
+              
+              
+              
+              
+            </h4>
+        
+            <div class="comments"> a vector string. to specify a list of keywords that
       must be included in the function definition. Warning: the string
       must start with a ',' for example: KWDLIST = ', TOTO = toto'
-
-      _EXTRA: used to pass your keywords to the created function.
-
- OUTPUTS: none 
-
- COMMON BLOCKS: none
+</div>
+            
+            <h4 id="_createfunc_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              
+              
+              
+              
+              
+              
+              
+              
+            </h4>
+        
+            <div class="comments"> used to pass your keywords to the created function.
 
  SIDE EFFECTS: ends the function name with '.pro' if needed
-
- RESTRICTIONS:arguments can be given only through keywords
-
- EXAMPLE:
+</div>
+            
+          
+
+          <h3>Examples</h3><div class="value"> 
       IDL> print, createfunc('3*2', filename='test')
       IDL> print, createfunc('3*two', filename = 'test' $
                                     , kwdlist ='two = two', two = 2)
 </div>
-
-          
-
-          
-            <h3>Parameters</h3>
-        
-            
-            <h4 id="_createfunc_param_command">command&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-              
-              
-              
-              
-              
-              
-              
-              
-            </h4>
-        
-          <div class="comments"></div>
-            
-
-          
-
-          
-
-            <h3>Keywords</h3>
-            
-            <h4 id="_createfunc_keyword_FILENAMEIN">FILENAMEIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-              
-              
-              
-              
-              
-              
-              
-              
-            </h4>
-        
-            <div class="comments"></div>
-            
-            <h4 id="_createfunc_keyword_KWDLIST">KWDLIST&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-              
-              
-              
-              
-              
-              
-              
-              
-            </h4>
-        
-            <div class="comments"></div>
-            
-            <h4 id="_createfunc_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)
+                      May 2005</div>
+          
+          
+          <h3>Known issues</h3>
+          
+          
+          
+          <h4>Restrictions</h4><div class="value"> arguments can be given only through keywords
+</div>