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

Location:
trunk/SRC/Documentation/idldoc_html_output/Calendar
Files:
7 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           

  • trunk/SRC/Documentation/idldoc_html_output/Calendar/date2string.html

    r89 r93  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
     89      <div id="file_comments"> keyword parameters of string function to specify the format of the month (the C format) can be used 
     90</div> 
    9091 
    9192       
    … …  
    102103        <div class="routine_details" id="_date2string"> 
    103104 
    104           <h2><a class="top" href="#container">top</a>date2string </h2> 
     105          <h2><a class="top" href="#container">top</a>date2string <span class="categories"> calendar, string 
     106</span></h2> 
    105107         
    106108          <p class="header"> 
    … …  
    108110         
    109111          <div class="comments"> 
    110  NAME: date2string 
    111  
    112  PURPOSE: create a nice and readable format to print a date 
    113  
    114  CATEGORY: calendar/string 
    115  
    116  CALLING SEQUENCE: nice_date = date2string(yyyymmdd) 
    117   
    118  INPUTS: yyyymmdd the date in the format  
    119          yearyearyearyearmonthmonthdayday 
    120  
    121  KEYWORD PARAMETERS:those of string fonction to specify the 
    122                     format of the month (the C format) 
    123  
    124  OUTPUTS: a string containing the date in a easy readable format 
    125  
    126  COMMON BLOCKS:none 
    127  
    128  SIDE EFFECTS:? 
    129  
    130  RESTRICTIONS:? 
    131  
    132  EXAMPLE: 
     112 
     113 create a nice and readable format to print a date 
     114</div> 
     115 
     116          <h3>Return value</h3><div class="value"> a string containing the date in a easy readable format 
     117</div> 
     118 
     119           
     120            <h3>Parameters</h3> 
     121         
     122             
     123            <h4 id="_date2string_param_yyyymmdd">yyyymmdd&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     124              <span class="attr">in</span> 
     125               
     126               
     127              <span class="attr">required</span> 
     128               
     129               
     130               
     131               
     132            </h4> 
     133         
     134          <div class="comments"> the date in the format yyyymmdd 
     135</div> 
     136             
     137 
     138           
     139 
     140           
     141 
     142            <h3>Keywords</h3> 
     143             
     144            <h4 id="_date2string_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     145               
     146               
     147               
     148               
     149               
     150               
     151               
     152               
     153            </h4> 
     154         
     155            <div class="comments"></div> 
     156             
     157           
     158 
     159          <h3>Examples</h3><div class="value">  
    133160 
    134161    IDL> print, date2string(19900123) 
    … …  
    137164    JAN 23, 1990 
    138165</div> 
    139  
    140            
    141  
    142            
    143             <h3>Parameters</h3> 
    144          
    145              
    146             <h4 id="_date2string_param_yyyymmdd">yyyymmdd&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    147                
    148                
    149                
    150                
    151                
    152                
    153                
    154                
    155             </h4> 
    156          
    157           <div class="comments"></div> 
    158              
    159  
    160            
    161  
    162            
    163  
    164             <h3>Keywords</h3> 
    165              
    166             <h4 id="_date2string_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    167                
    168                
    169                
    170                
    171                
    172                
    173                
    174                
    175             </h4> 
    176          
    177             <div class="comments"></div> 
    178              
    179            
    180  
    181            
    182            
    183            
    184            
    185            
     166          <h3>Version history</h3> 
     167           
     168           
     169          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     170 Creation ??? 
     171 update/review June 2005 Sebastien Masson.</div> 
    186172           
    187173           

  • 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           

  • trunk/SRC/Documentation/idldoc_html_output/Calendar/directory-overview.html

    r89 r93  
    9393       
    9494        <dt><a href="date2string.html?format=raw">date2string.pro</a></dt> 
    95         <dd></dd> 
     95        <dd> keyword parameters of string function to specify the format of the month (the C format) can be used </dd> 
    9696       
    9797        <dt><a href="daysinmonth.html?format=raw">daysinmonth.pro</a></dt> 
    … …  
    105105       
    106106        <dt><a href="monthname.html?format=raw">monthname.pro</a></dt> 
    107         <dd></dd> 
     107        <dd> keyword parameters of string function to specify the format of the month (the C format) can be used.</dd> 
    108108       
    109109      </dl> 

  • trunk/SRC/Documentation/idldoc_html_output/Calendar/jul2date.html

    r89 r93  
    102102        <div class="routine_details" id="_jul2date"> 
    103103 
    104           <h2><a class="top" href="#container">top</a>jul2date </h2> 
     104          <h2><a class="top" href="#container">top</a>jul2date <span class="categories"> calendar 
     105</span></h2> 
    105106         
    106107          <p class="header"> 
    … …  
    108109         
    109110          <div class="comments"> 
    110  NAME: jul2date 
    111111 
    112  PURPOSE: gives yyyymmdd date equivalent of a julian day 
    113  
    114  CATEGORY: calendar 
    115  
    116  CALLING SEQUENCE: date = jul2date(jday) 
    117  
    118  INPUTS:jday: julian day 
    119  
    120  KEYWORD PARAMETERS: None 
    121  
    122  OUTPUTS: date in yyyymmdd format 
    123  
    124  COMMON BLOCKS: None 
    125  
    126  SIDE EFFECTS: 
    127  
    128  RESTRICTIONS: 
    129  
    130  EXAMPLE: 
    131  
    132     IDL> print, jul2date(julday(12,23,1999)) 
    133         19991223 
     112 gives yyyymmdd date equivalent of a julian day 
    134113</div> 
    135114 
    136            
     115          <h3>Return value</h3><div class="value"> date in yyyymmdd format 
     116</div> 
    137117 
    138118           
    … …  
    141121             
    142122            <h4 id="_jul2date_param_jday">jday&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     123              <span class="attr">in</span> 
    143124               
    144125               
    145                
    146                
     126              <span class="attr">required</span> 
    147127               
    148128               
    … …  
    151131            </h4> 
    152132         
    153           <div class="comments"></div> 
     133          <div class="comments"> julian day 
     134</div> 
    154135             
    155136 
    … …  
    158139           
    159140 
     141          <h3>Examples</h3><div class="value">  
     142 
     143    IDL> print, jul2date(julday(12,23,1999)) 
     144        19991223 
     145</div> 
     146          <h3>Version history</h3> 
    160147           
    161148           
    162            
    163            
    164            
     149          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     150                       June 2005</div> 
    165151           
    166152           

  • trunk/SRC/Documentation/idldoc_html_output/Calendar/leapyr.html

    r89 r93  
    102102        <div class="routine_details" id="_leapyr"> 
    103103 
    104           <h2><a class="top" href="#container">top</a>leapyr </h2> 
     104          <h2><a class="top" href="#container">top</a>leapyr <span class="categories"> calendar 
     105</span></h2> 
    105106         
    106107          <p class="header"> 
    107108            <span class="result">result = </span>leapyr(<span class="result"><a href="#_leapyr_param_year">year</a></span>)</p> 
    108109         
    109           <div class="comments"></div> 
     110          <div class="comments"> 
    110111 
    111            
     112 determine whether the input year is a leap year or not 
     113 Very useful for finding number of days in a year. 
     114 eg. NUM_DAYS_IN_YR = 365 + leapyr(year) 
     115</div> 
     116 
     117          <h3>Return value</h3><div class="value"> 0 then not a leap year  
     118          1 then year is a leap year 
     119</div> 
    112120 
    113121           
    … …  
    116124             
    117125            <h4 id="_leapyr_param_year">year&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     126              <span class="attr">in</span> 
    118127               
    119128               
    120                
    121                
     129              <span class="attr">required</span> 
    122130               
    123131               
    … …  
    126134            </h4> 
    127135         
    128           <div class="comments"></div> 
     136          <div class="comments"> year to be tested as a leap year 
     137</div> 
    129138             
    130139 
    … …  
    133142           
    134143 
     144          <h3>Examples</h3><div class="value"> 
     145 IDL> result = leapyr(2000) 
     146</div> 
     147          <h3>Version history</h3> 
    135148           
    136149           
    137            
    138            
    139            
     150          <h4>History</h4><div class="value"> 
     151 
     152 Originally Written by: Trevor Harris, Physics Dept., University of Adelaide, 
     15320/09/88 
     154 
     155       November 2004: correction for century years... S. Masson; 
     156 
     157       Every year divisible by 4 is a leap year.  
     158       But every year divisible by 100 is NOT a leap year  
     159       Unless the year is also divisible by 400, then it is still a 
     160       leap year. 
     161       This means that year 1800, 1900, 2100, 2200, 2300 and 2500 are 
     162       NOT leap years, while year 2000 and 2400 are leap years.  
     163       + supress the automatic change 89 -> 1989 
     164 
     165       June 2005 update for new commons, Sebastien Masson. 
     166</div> 
    140167           
    141168           
    … …  
    146173           
    147174         
     175          <h3>Other attributes</h3> 
    148176           
    149177           
    150            
    151            
     178          <h4>Uses routines</h4><div class="value"> cm_4cal 
     179</div> 
    152180           
    153181           

  • trunk/SRC/Documentation/idldoc_html_output/Calendar/monthname.html

    r89 r93  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
     89      <div id="file_comments"> keyword parameters of string function to specify the format of the month (the C format) can be used. 
     90</div> 
    9091 
    9192       
    … …  
    102103        <div class="routine_details" id="_monthname"> 
    103104 
    104           <h2><a class="top" href="#container">top</a>monthname </h2> 
     105          <h2><a class="top" href="#container">top</a>monthname <span class="categories"> calendar 
     106 </span></h2> 
    105107         
    106108          <p class="header"> 
    … …  
    108110         
    109111          <div class="comments"> 
    110  NAME:monthname 
    111112 
    112  PURPOSE:gives the name of a month 
    113  
    114  CATEGORY: 
    115  
    116  CALLING SEQUENCE:name=monthname(number) 
    117   
    118  INPUTS: number, the month number (from 1 to 12) 
    119  
    120  KEYWORD PARAMETERS:those of string fonction to specify the 
    121                     format of the month (the C format) 
    122  
    123  OUTPUTS: an integer, the month's name 
    124  
    125  COMMON BLOCKS:None 
    126  
    127  SIDE EFFECTS: 
    128  
    129  RESTRICTIONS: 
    130  
    131  EXAMPLE: 
     113 gives the name of a month 
    132114</div> 
    133115 
    134            
     116          <h3>Return value</h3><div class="value"> the month's name 
     117</div> 
    135118 
    136119           
    … …  
    173156           
    174157 
     158          <h3>Examples</h3><div class="value">  
     159 IDL> name=monthname(2) 
     160</div> 
     161          <h3>Version history</h3> 
    175162           
    176163           
    177            
    178            
    179            
     164          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     165                      1 October 2001</div> 
    180166           
    181167           
Note: See TracChangeset for help on using the changeset viewer.