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/protype.html

    r89 r93  
    102102        <div class="routine_details" id="_protype"> 
    103103 
    104           <h2><a class="top" href="#container">top</a>protype </h2> 
     104          <h2><a class="top" href="#container">top</a>protype <span class="categories"> utilities 
     105</span></h2> 
    105106         
    106107          <p class="header"> 
     
    108109         
    109110          <div class="comments"> 
    110  NAME: protype 
     111 test is a ".pro" file corresponds to an IDL procedure, 
     112          function or batch file. 
     113</div> 
    111114 
    112  PURPOSE: test is a ".pro" file corresponds to an IDL procedure, 
    113           function or batch file. 
     115          <h3>Return value</h3><div class="value"> A scalar of string type: 'proc', 'func' or 'batch' 
     116</div> 
    114117 
    115  CATEGORY: 
     118           
     119            <h3>Parameters</h3> 
     120         
     121             
     122            <h4 id="_protype_param_file">file&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     123              <span class="attr">in</span> 
     124               
     125               
     126               
     127               
     128               
     129               
     130               
     131            </h4> 
     132         
     133          <div class="comments"> A scalar of string type, the name of the ".pro" file to be tested 
     134    if necessary, the input name is completed with '.pro' 
     135     and its path found in !path 
     136</div> 
     137             
    116138 
    117  CALLING SEQUENCE: type = protype(profilename) 
     139           
    118140 
    119  INPUTS: A scalar of string type, the name of the ".pro" file to be tested  
    120      if necessary, the input name is completed with '.pro' 
    121      and its path found in !path 
     141           
    122142 
    123  KEYWORD PARAMETERS: NONE 
    124  
    125  OUTPUTS: A scalar of string type: 'proc', 'func' or 'batch' 
    126  
    127  COMMON BLOCKS: none 
    128  
    129  SIDE EFFECTS: 
    130  
    131  RESTRICTIONS: 
    132  
    133  EXAMPLE: 
     143          <h3>Examples</h3><div class="value">  
    134144 
    135145      IDL> print, protype('protype') 
     
    142152      proc 
    143153</div> 
    144  
    145            
    146  
    147            
    148             <h3>Parameters</h3> 
    149          
    150              
    151             <h4 id="_protype_param_file">file&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    152                
    153                
    154                
    155                
    156                
    157                
    158                
    159                
    160             </h4> 
    161          
    162           <div class="comments"></div> 
    163              
    164  
    165            
    166  
    167            
    168  
     154          <h3>Version history</h3> 
    169155           
    170156           
    171            
    172            
    173            
     157          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     158                       Feb 2006</div> 
    174159           
    175160           
Note: See TracChangeset for help on using the changeset viewer.