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

    r89 r93  
    102102        <div class="routine_details" id="_date2jul"> 
    103103 
    104           <h2><a class="top" href="#container">top</a>date2jul </h2> 
     104          <h2><a class="top" href="#container">top</a>date2jul <span class="categories"> calendar 
     105</span></h2> 
    105106         
    106107          <p class="header"> 
    107             <span class="result">result = </span>date2jul(<span class="result"><a href="#_date2jul_param_date">date</a></span>, <a href="#_date2jul_keyword_GRADS">GRADS</a>=<span class="result">GRADS</span>)</p> 
     108            <span class="result">result = </span>date2jul(<span class="result"><a href="#_date2jul_param_date">date</a></span>[, <a href="#_date2jul_keyword_GRADS">GRADS</a>=<span class="result">GRADS</span>])</p> 
    108109         
    109110          <div class="comments"> 
    110  NAME: date2jul 
    111  
    112  PURPOSE: gives julian day equivalent of a date in yyyymmdd format  
    113  
    114  CATEGORY: calendar 
    115  
    116  CALLING SEQUENCE: jday = juldate(19930124) 
    117  
    118  INPUTS: date in yyyymmdd format 
    119  
    120  KEYWORD PARAMETERS: 
    121  
    122        /GRADS: if  1 <= year <= 49 --> year = 2000 + year 
     111 
     112 gives julian day equivalent of a date in yyyymmdd format  
     113</div> 
     114 
     115          <h3>Return value</h3><div class="value"> date in julian day 
     116</div> 
     117 
     118           
     119            <h3>Parameters</h3> 
     120         
     121             
     122            <h4 id="_date2jul_param_date">date&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     123              <span class="attr">in</span> 
     124               
     125               
     126              <span class="attr">required</span> 
     127               
     128               
     129               
     130               
     131            </h4> 
     132         
     133          <div class="comments"> date in yyyymmdd format 
     134</div> 
     135             
     136 
     137           
     138 
     139           
     140 
     141            <h3>Keywords</h3> 
     142             
     143            <h4 id="_date2jul_keyword_GRADS">GRADS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     144              <span class="attr">in</span> 
     145               
     146              <span class="attr">optional</span> 
     147               
     148               
     149               
     150               
     151               
     152            </h4> 
     153         
     154            <div class="comments">  
     155               if  1 <= year <= 49 --> year = 2000 + year 
    123156               if 50 <= year <= 99 --> year = 1900 + year 
    124  
    125  OUTPUTS:date en jour julien 
    126  
    127  COMMON BLOCKS: none 
    128  
    129  SIDE EFFECTS: ? 
    130  
    131  RESTRICTIONS: ? 
    132  
    133  EXAMPLE: 
    134  
     157</div> 
     158             
     159           
     160 
     161          <h3>Examples</h3><div class="value">  
     162 
     163    IDL> jday = juldate(19930124) 
    135164    IDL> print, date2jul(19931205) EQ julday(12,5,1993)  
    136165       1 
     
    138167       1 
    139168</div> 
    140  
    141            
    142  
    143            
    144             <h3>Parameters</h3> 
    145          
    146              
    147             <h4 id="_date2jul_param_date">date&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    148                
    149                
    150                
    151                
    152                
    153                
    154                
    155                
    156             </h4> 
    157          
    158           <div class="comments"></div> 
    159              
    160  
    161            
    162  
    163            
    164  
    165             <h3>Keywords</h3> 
    166              
    167             <h4 id="_date2jul_keyword_GRADS">GRADS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    168                
    169                
    170                
    171                
    172                
    173                
    174                
    175                
    176             </h4> 
    177          
    178             <div class="comments"></div> 
    179              
    180            
    181  
    182            
    183            
    184            
    185            
    186            
     169          <h3>Version history</h3> 
     170           
     171           
     172          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     173                       June 2005</div> 
    187174           
    188175           
Note: See TracChangeset for help on using the changeset viewer.