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/Calendar/daysinmonth.html

    r89 r93  
    102102        <div class="routine_details" id="_daysinmonth"> 
    103103 
    104           <h2><a class="top" href="#container">top</a>daysinmonth </h2> 
     104          <h2><a class="top" href="#container">top</a>daysinmonth <span class="categories"> calendar 
     105 
     106</span></h2> 
    105107         
    106108          <p class="header"> 
    107             <span class="result">result = </span>daysinmonth(<span class="result"><a href="#_daysinmonth_param_month">month</a>, <a href="#_daysinmonth_param_year">year</a></span>)</p> 
     109            <span class="result">result = </span>daysinmonth(<span class="result">[<a href="#_daysinmonth_param_month">month</a>][, <a href="#_daysinmonth_param_year">year</a>]</span>)</p> 
    108110         
    109111          <div class="comments"> 
    110  NAME:daysinmonth 
    111112 
    112  PURPOSE:give the nomber of days in a specefic month 
    113  
    114  CATEGORY: calandar 
    115  
    116  CALLING SEQUENCE: ndays = daysinmonth([month[, year]]) 
    117  
    118  INPUTS (optionnal): month and year. Year is used only if the 
    119       common variable key_caltype = 'greg'. In that case, month 
    120       and year must have the same number of elements. if not 
    121       provided, we take month and year from "time" common variable. 
    122  
    123  KEYWORD PARAMETERS: 
    124  
    125  OUTPUTS: 
    126  
    127  COMMON BLOCKS: cm_4cal 
    128          
    129  SIDE EFFECTS: return -1 in case of error 
    130  
    131  RESTRICTIONS: 
    132  
    133  EXAMPLE: 
     113 give the number of days in a specific month 
    134114</div> 
    135115 
    136            
     116          <h3>Return value</h3><div class="value"> number of days in a month or -1 in case of error 
     117</div> 
    137118 
    138119           
     
    141122             
    142123            <h4 id="_daysinmonth_param_month">month&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     124              <span class="attr">in</span> 
    143125               
    144                
    145                
     126              <span class="attr">optional</span> 
    146127               
    147128               
     
    151132            </h4> 
    152133         
    153           <div class="comments"></div> 
     134          <div class="comments"> </div> 
    154135             
    155136            <h4 id="_daysinmonth_param_year">year&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     137              <span class="attr">in</span> 
    156138               
    157                
    158                
     139              <span class="attr">optional</span> 
    159140               
    160141               
     
    164145            </h4> 
    165146         
    166           <div class="comments"></div> 
     147          <div class="comments">  
     148 Year is used only if the  common variable key_caltype = 'greg'.  
     149 In that case, month and year must have the same number of elements.  
     150 If not provided, we take month and year from "time" common variable. 
     151</div> 
    167152             
    168153 
     
    171156           
    172157 
     158          <h3>Examples</h3><div class="value">  
     159 IDL> ndays = daysinmonth(2, 2000) 
     160</div> 
     161          <h3>Version history</h3> 
    173162           
    174163           
    175            
    176            
    177            
     164          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     165                        2/7/98 
     166 update/review/english/new commons: June 2005 Sebastien Masson.</div> 
    178167           
    179168           
     
    184173           
    185174         
     175          <h3>Other attributes</h3> 
    186176           
    187177           
    188            
    189            
     178          <h4>Uses routines</h4><div class="value"> cm_4cal 
     179        </div> 
    190180           
    191181           
Note: See TracChangeset for help on using the changeset viewer.