Ignore:
Timestamp:
12/03/07 16:41:25 (17 years ago)
Author:
smasson
Message:

update documentation

Location:
trunk/SRC/Documentation/idldoc_html_output/Calendar
Files:
8 edited

Legend:

Unmodified
Added
Removed

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

    r290 r321  
    8989      <div id="file_comments"> 
    9090 Return the calendar date and time given julian date. 
    91  This is the inverse of the function 
    92  <a href="..//Calendar/julday.html">julday</a>. 
     91 This is the inverse of the function <a href="..//Calendar/julday.html">julday</a>. 
    9392 3 calendars are available according to the value of key_caltype 
    9493 (variable of the common file cm_4cal): 'greg', '360d', 'noleap' 
    … …  
    130129              <span class="attr">required</span> 
    131130               
    132               <span class="attr">type:</span> <span class="value">long integer</span> 
     131              <span class="attr">type:</span> <span class="value">long integer or double-precision floating-point</span> 
    133132               
    134133               
    … …  
    146145               
    147146               
    148               <span class="attr">type:</span> <span class="value">integer</span> 
     147              <span class="attr">type:</span> <span class="value">longword integer</span> 
    149148               
    150149               
    … …  
    161160               
    162161               
    163               <span class="attr">type:</span> <span class="value">integer</span> 
     162              <span class="attr">type:</span> <span class="value">longword integer</span> 
    164163               
    165164               
    … …  
    176175               
    177176               
    178               <span class="attr">type:</span> <span class="value">integer</span> 
     177              <span class="attr">type:</span> <span class="value">longword integer</span> 
    179178               
    180179               
    … …  
    191190               
    192191               
    193               <span class="attr">type:</span> <span class="value">integer</span> 
     192              <span class="attr">type:</span> <span class="value">longword integer</span> 
    194193               
    195194               
    … …  
    206205               
    207206               
    208               <span class="attr">type:</span> <span class="value">integer</span> 
     207              <span class="attr">type:</span> <span class="value">longword integer</span> 
    209208               
    210209               
    … …  
    221220               
    222221               
    223               <span class="attr">type:</span> <span class="value">float</span> 
     222              <span class="attr">type:</span> <span class="value">double-precision floating-point</span> 
    224223               
    225224               
    … …  
    259258           
    260259          <h4>Version</h4><div class="preformat"> 
    261  $Id: caldat.pro 261 2007-08-20 16:08:13Z pinsard $ 
     260 $Id: caldat.pro 318 2007-12-03 14:21:21Z smasson $ 
    262261</div> 
    263262          <h4>History</h4><div class="preformat"> 
    264  Translated from "Numerical Recipies in C", by William H. Press, 
     263 Translated from "Numerical Recipes in C", by William H. Press, 
    265264 Brian P. Flannery, Saul A. Teukolsky, and William T. Vetterling. 
    266265 Cambridge University Press, 1988 (second printing). 

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

    r290 r321  
    8888 
    8989      <div id="file_comments"> 
    90  gives Julian day equivalent of a date in yyyymmdd format 
     90 gives Julian day equivalent of a date given in yyyymmdd format 
     91 This is the inverse of the function <a href="..//Calendar/jul2date.html">jul2date</a>. 
    9192</div> 
    9293 
    … …  
    128129              <span class="attr">required</span> 
    129130               
    130               <span class="attr">type:</span> <span class="value">long or double, sacalr or array</span> 
     131              <span class="attr">type:</span> <span class="value">long or double, scalar or array</span> 
    131132               
    132133               
    … …  
    282283           
    283284          <h4>Version</h4><div class="preformat"> 
    284  $Id: date2jul.pro 279 2007-09-07 13:40:51Z smasson $ 
     285 $Id: date2jul.pro 318 2007-12-03 14:21:21Z smasson $ 
    285286</div> 
    286287          <h4>History</h4><div class="preformat"> 

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

    r249 r321  
    157157         
    158158            <div class="comments"> 
    159  Used to pass keywords 
     159 Used to pass keywords to <proidl>string</proidl> function 
    160160</div> 
    161161             
    … …  
    172172           
    173173          <h4>Version</h4><div class="preformat"> 
    174  $Id: date2string.pro 238 2007-03-27 13:43:18Z pinsard $ 
     174 $Id: date2string.pro 318 2007-12-03 14:21:21Z smasson $ 
    175175</div> 
    176176          <h4>History</h4><div class="preformat"> 

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

    r249 r321  
    165165           
    166166          <h4>Version</h4><div class="preformat"> 
    167  $Id: daysinmonth.pro 238 2007-03-27 13:43:18Z pinsard $ 
     167 $Id: daysinmonth.pro 318 2007-12-03 14:21:21Z smasson $ 
    168168</div> 
    169169          <h4>History</h4><div class="preformat"> 

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

    r249 r321  
    9393       
    9494        <dt><a href="date2jul.html">date2jul.pro</a></dt> 
    95         <dd>  gives Julian day equivalent of a date in yyyymmdd format </dd> 
     95        <dd>  gives Julian day equivalent of a date given in yyyymmdd format  This is the inverse of the function <a href="..//Calendar/jul2date.html">jul2date</a>.</dd> 
    9696       
    9797        <dt><a href="date2string.html">date2string.pro</a></dt> 
    … …  
    102102       
    103103        <dt><a href="jul2date.html">jul2date.pro</a></dt> 
    104         <dd>  gives yyyymmdd date equivalent of a Julian day </dd> 
     104        <dd>  gives yyyymmdd date equivalent of a Julian day  This is the inverse of the function <a href="..//Calendar/date2jul.html">date2jul</a>.</dd> 
    105105       
    106106        <dt><a href="julday.html">julday.pro</a></dt> 

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

    r290 r321  
    8989      <div id="file_comments"> 
    9090 gives yyyymmdd date equivalent of a Julian day 
     91 This is the inverse of the function <a href="..//Calendar/date2jul.html">date2jul</a>. 
    9192</div> 
    9293 
    … …  
    130131              <span class="attr">required</span> 
    131132               
    132               <span class="attr">type:</span> <span class="value">long or double, sacalr or array</span> 
     133              <span class="attr">type:</span> <span class="value">long or double, scalar or array</span> 
    133134               
    134135               
    … …  
    265266           
    266267          <h4>Version</h4><div class="preformat"> 
    267  $Id: jul2date.pro 279 2007-09-07 13:40:51Z smasson $ 
     268 $Id: jul2date.pro 318 2007-12-03 14:21:21Z smasson $ 
    268269</div> 
    269270          <h4>History</h4><div class="preformat"> 

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

    r290 r321  
    8989      <div id="file_comments"> 
    9090 Calculate the Julian Day Number for a given month, day, and year. 
    91  This is the inverse of the library function 
    92  <a href="..//Calendar/caldat.html">caldat</a>. 
     91 This is the inverse of the library function <a href="..//Calendar/caldat.html">caldat</a>. 
    9392 3 calendars are available according to the value of key_caltype 
    9493 (variable of the common file cm_4cal): 'greg', '360d', 'noleap' 
    … …  
    113112         
    114113          <p class="header"> 
    115             <span class="result">result = </span>julday(<span class="result"><a href="#_julday_param_month">month</a>, <a href="#_julday_param_day">day</a>, <a href="#_julday_param_yearin">yearin</a>[, <a href="#_julday_param_hour">hour</a>][, <a href="#_julday_param_minute">minute</a>][, <a href="#_julday_param_second">second</a>]</span>, <a href="#_julday_keyword_NDAYSPM">NDAYSPM</a>=<span class="result">integer</span>)</p> 
     114            <span class="result">result = </span>julday(<span class="result">[<a href="#_julday_param_month">month</a>][, <a href="#_julday_param_day">day</a>][, <a href="#_julday_param_yearin">yearin</a>][, <a href="#_julday_param_hour">hour</a>][, <a href="#_julday_param_minute">minute</a>][, <a href="#_julday_param_second">second</a>]</span>, <a href="#_julday_keyword_NDAYSPM">NDAYSPM</a>=<span class="result">integer</span>)</p> 
    116115         
    117116          <div class="comments"> 
    … …  
    132131              <span class="attr">in</span> 
    133132               
    134                
    135               <span class="attr">required</span> 
     133              <span class="attr">optional</span> 
     134               
    136135               
    137136              <span class="attr">type:</span> <span class="value">scalar (integer or double) or array of scalars</span> 
    … …  
    147146              <span class="attr">in</span> 
    148147               
    149                
    150               <span class="attr">required</span> 
     148              <span class="attr">optional</span> 
     149               
    151150               
    152151              <span class="attr">type:</span> <span class="value">scalar (integer or double) or array of scalars</span> 
    … …  
    162161              <span class="attr">in</span> 
    163162               
    164                
    165               <span class="attr">required</span> 
     163              <span class="attr">optional</span> 
     164               
    166165               
    167166              <span class="attr">type:</span> <span class="value">scalar (integer or double) or array of scalars</span> 
    … …  
    256255           
    257256          <h4>Version</h4><div class="preformat"> 
    258  $Id: julday.pro 279 2007-09-07 13:40:51Z smasson $</div> 
     257 $Id: julday.pro 318 2007-12-03 14:21:21Z smasson $</div> 
    259258          <h4>History</h4><div class="preformat"> 
    260  Translated from "Numerical Recipies in C", by William H. Press, 
     259 Translated from "Numerical Recipes in C", by William H. Press, 
    261260 Brian P. Flannery, Saul A. Teukolsky, and William T. Vetterling. 
    262261 Cambridge University Press, 1988 (second printing). 

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

    r249 r321  
    156156         
    157157            <div class="comments"> 
    158  Used to pass keywords 
     158 Used to pass keywords to <proidl>string</proidl> function 
    159159</div> 
    160160             
    … …  
    162162 
    163163          <h3>Examples</h3><div class="preformat"> 
    164  IDL> name=monthname(2) 
     164   IDL> print, monthname([2,3]) 
     165   February March 
     166   IDL> print, monthname(2, format='(C(CMOA0))') 
     167   FEBRUARY 
     168   IDL> print, monthname(2, format='(C(CmoA03,":"))') 
     169   feb 
    165170</div> 
    166171          <h3>Version history</h3> 
    167172           
    168173          <h4>Version</h4><div class="preformat"> 
    169  $Id: monthname.pro 231 2007-03-19 17:15:51Z pinsard $ 
     174 $Id: monthname.pro 318 2007-12-03 14:21:21Z smasson $ 
    170175</div> 
    171176          <h4>History</h4><div class="preformat"> 
Note: See TracChangeset for help on using the changeset viewer.