Ignore:
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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/SRC/Documentation/idldoc_html_output/Utilities/createpro.html

    r89 r93  
    108108         
    109109          <div class="comments"> 
    110  NAME:createpro 
    111  
    112  PURPOSE: write an idl procedure, compile it and execute it. 
    113  
    114  CATEGORY: 
    115  
    116  CALLING SEQUENCE:createpro, command 
    117   
    118  INPUTS: 
    119       command: a string array defining the procedure to be created. 
    120       each element will be a line of the created procedure.  
    121  
    122  KEYWORD PARAMETERS: 
    123  
    124       FILENAMEIN: name of the procedure to be created. 
     110 write an idl procedure, compile it and execute it. 
     111</div> 
     112 
     113           
     114 
     115           
     116            <h3>Parameters</h3> 
     117         
     118             
     119            <h4 id="_createpro_param_command">command&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     120              <span class="attr">in</span> 
     121               
     122               
     123              <span class="attr">required</span> 
     124               
     125               
     126               
     127               
     128            </h4> 
     129         
     130          <div class="comments"> a string array defining the procedure to be created. each element will be a line of the created procedure.  
     131</div> 
     132             
     133 
     134           
     135 
     136           
     137 
     138            <h3>Keywords</h3> 
     139             
     140            <h4 id="_createpro_keyword_FILENAMEIN">FILENAMEIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     141               
     142               
     143               
     144               
     145               
     146               
     147               
     148               
     149            </h4> 
     150         
     151            <div class="comments"> name of the procedure to be created. 
    125152      'for_createpro.pro' by default 
    126  
    127       KWDLIST: a vector string. to specify a list of keywords that 
     153</div> 
     154             
     155            <h4 id="_createpro_keyword_KWDLIST">KWDLIST&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     156               
     157               
     158               
     159               
     160               
     161               
     162               
     163               
     164            </h4> 
     165         
     166            <div class="comments"> a vector string. to specify a list of keywords that 
    128167      must be included in the procedure definition. Warning: the string 
    129168      must start with a ',' for example: KWDLIST = ', TOTO = toto' 
    130  
    131       _EXTRA: used to pass your keywords to the created procedure. 
    132  
    133  OUTPUTS: none  
    134  
    135  COMMON BLOCKS: none 
     169</div> 
     170             
     171            <h4 id="_createpro_keyword_KWDUSED">KWDUSED&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     172               
     173               
     174               
     175               
     176               
     177               
     178               
     179               
     180            </h4> 
     181         
     182            <div class="comments"></div> 
     183             
     184            <h4 id="_createpro_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     185               
     186               
     187               
     188               
     189               
     190               
     191               
     192               
     193            </h4> 
     194         
     195            <div class="comments"> used to pass your keywords to the created procedure. 
    136196 
    137197 SIDE EFFECTS: ends the procedure name with '.pro' if needed 
    138  
    139  RESTRICTIONS:is not working with functions, use createfunc instead. 
    140               arguments can be given only through keywords 
    141  
    142  EXAMPLE: 
     198</div> 
     199             
     200           
     201 
     202          <h3>Examples</h3><div class="value">  
    143203      IDL> createpro, ['print,''OK'''], filename='test' 
    144204      IDL> createpro, ['if keyword_set(ok) then print,''OK'' else print, ''No'''] $ 
     
    148208 
    149209</div> 
    150  
    151            
    152  
    153            
    154             <h3>Parameters</h3> 
    155          
    156              
    157             <h4 id="_createpro_param_command">command&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    158                
    159                
    160                
    161                
    162                
    163                
    164                
    165                
    166             </h4> 
    167          
    168           <div class="comments"></div> 
    169              
    170  
    171            
    172  
    173            
    174  
    175             <h3>Keywords</h3> 
    176              
    177             <h4 id="_createpro_keyword_FILENAMEIN">FILENAMEIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    178                
    179                
    180                
    181                
    182                
    183                
    184                
    185                
    186             </h4> 
    187          
    188             <div class="comments"></div> 
    189              
    190             <h4 id="_createpro_keyword_KWDLIST">KWDLIST&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    191                
    192                
    193                
    194                
    195                
    196                
    197                
    198                
    199             </h4> 
    200          
    201             <div class="comments"></div> 
    202              
    203             <h4 id="_createpro_keyword_KWDUSED">KWDUSED&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    204                
    205                
    206                
    207                
    208                
    209                
    210                
    211                
    212             </h4> 
    213          
    214             <div class="comments"></div> 
    215              
    216             <h4 id="_createpro_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    217                
    218                
    219                
    220                
    221                
    222                
    223                
    224                
    225             </h4> 
    226          
    227             <div class="comments"></div> 
    228              
    229            
    230  
    231            
    232            
    233            
    234            
    235            
    236            
    237            
    238            
    239            
    240            
    241            
    242            
     210          <h3>Version history</h3> 
     211           
     212           
     213          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     214 cleaning + new keywords: October 2005 
     215 Feb. 2006: supress keyword "kwdused" and use call_procedure instead of execute</div> 
     216           
     217           
     218          <h3>Known issues</h3> 
     219           
     220           
     221           
     222          <h4>Restrictions</h4><div class="value"> is not working with functions, use createfunc instead. 
     223              arguments can be given only through keywords 
     224</div> 
    243225         
    244226           
Note: See TracChangeset for help on using the changeset viewer.