source: trunk/SRC/Documentation/idldoc_html_output/Calendar/leapyr.html @ 104

Last change on this file since 104 was 104, checked in by pinsard, 18 years ago

start to modify headers of Postscript *.pro files for better idldoc output + change the title of idldoc output in html to SAXO Documentation
File size: 4.2 KB
RevLine 
[89]1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
[104]9    <title>leapyr.pro (SAXO Documentation)</title>
[89]10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
[104]18        parent.document.title="leapyr.pro (SAXO Documentation)";
[89]19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
[104]26  <h1>SAXO Documentation</h1>
[89]27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../overview.html?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="jul2date.html">&lt;&lt;prev file</a> | <a href="monthname.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="leapyr.html" target="_TOP">view single page</a> | <a href="./../index.html?format=raw" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html?format=raw">Calendar/</a></h1>
82      <h2 class="pro_file">leapyr.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
[97]89      <div id="file_comments"> determine whether the input year is a leap year or not
90 Very useful for finding number of days in a year.
91 eg. NUM_DAYS_IN_YR = 365 + leapyr(year)
92</div>
[89]93
94     
95
96     
97
98     
99
100     
101
102      <div id="routine_details">
103       
104
105        <div class="routine_details" id="_leapyr">
106
[93]107          <h2><a class="top" href="#container">top</a>leapyr <span class="categories"> calendar
108</span></h2>
[89]109       
110          <p class="header">
111            <span class="result">result = </span>leapyr(<span class="result"><a href="#_leapyr_param_year">year</a></span>)</p>
112       
[93]113          <div class="comments">
114</div>
[89]115
[93]116          <h3>Return value</h3><div class="value"> 0 then not a leap year
117          1 then year is a leap year
118</div>
119
[89]120         
121            <h3>Parameters</h3>
122       
123           
124            <h4 id="_leapyr_param_year">year&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[93]125              <span class="attr">in</span>
[89]126             
127             
[93]128              <span class="attr">required</span>
[89]129             
130             
131             
132             
133            </h4>
134       
[93]135          <div class="comments"> year to be tested as a leap year
136</div>
[89]137           
138
139         
140
141         
142
[93]143          <h3>Examples</h3><div class="value">
144 IDL> result = leapyr(2000)
145</div>
146          <h3>Version history</h3>
[89]147         
148         
[93]149          <h4>History</h4><div class="value">
150
151 Originally Written by: Trevor Harris, Physics Dept., University of Adelaide,
15220/09/88
153
154       November 2004: correction for century years... S. Masson;
155
156       Every year divisible by 4 is a leap year.
157       But every year divisible by 100 is NOT a leap year
158       Unless the year is also divisible by 400, then it is still a
159       leap year.
160       This means that year 1800, 1900, 2100, 2200, 2300 and 2500 are
161       NOT leap years, while year 2000 and 2400 are leap years.
162       + supress the automatic change 89 -> 1989
163
164       June 2005 update for new commons, Sebastien Masson.
165</div>
[89]166         
167         
168         
169         
170         
171         
172         
173       
[93]174          <h3>Other attributes</h3>
[89]175         
176         
[93]177          <h4>Uses routines</h4><div class="value"> cm_4cal
178</div>
[89]179         
180         
181         
182       
183         
184       
185        </div>
186       
187      </div>
188
189     
190
191      <div id="tagline">Produced by IDLdoc 2.0.</div>
192
193    </div>
194
195  </body>
196</html>
Note: See TracBrowser for help on using the repository browser.