source: trunk/SRC/Documentation/idldoc_html_output/Calendar/daysinmonth.html @ 93

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

start to modify headers of Calendar and Utilities *.pro files for bet
ter idldoc output
File size: 4.2 KB
Line 
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>
9    <title>daysinmonth.pro (IDLdoc API documentation)</title>
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() {
18        parent.document.title="daysinmonth.pro (IDLdoc API documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>IDLdoc API documentation</h1>
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="date2string.html">&lt;&lt;prev file</a> | <a href="jul2date.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="daysinmonth.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">daysinmonth.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments"></div>
90
91     
92
93     
94
95     
96
97     
98
99      <div id="routine_details">
100       
101
102        <div class="routine_details" id="_daysinmonth">
103
104          <h2><a class="top" href="#container">top</a>daysinmonth <span class="categories"> calendar
105
106</span></h2>
107       
108          <p class="header">
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>
110       
111          <div class="comments">
112
113 give the number of days in a specific month
114</div>
115
116          <h3>Return value</h3><div class="value"> number of days in a month or -1 in case of error
117</div>
118
119         
120            <h3>Parameters</h3>
121       
122           
123            <h4 id="_daysinmonth_param_month">month&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
124              <span class="attr">in</span>
125             
126              <span class="attr">optional</span>
127             
128             
129             
130             
131             
132            </h4>
133       
134          <div class="comments"> </div>
135           
136            <h4 id="_daysinmonth_param_year">year&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
137              <span class="attr">in</span>
138             
139              <span class="attr">optional</span>
140             
141             
142             
143             
144             
145            </h4>
146       
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>
152           
153
154         
155
156         
157
158          <h3>Examples</h3><div class="value"> 
159 IDL> ndays = daysinmonth(2, 2000)
160</div>
161          <h3>Version history</h3>
162         
163         
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>
167         
168         
169         
170         
171         
172         
173         
174       
175          <h3>Other attributes</h3>
176         
177         
178          <h4>Uses routines</h4><div class="value"> cm_4cal
179        </div>
180         
181         
182         
183       
184         
185       
186        </div>
187       
188      </div>
189
190     
191
192      <div id="tagline">Produced by IDLdoc 2.0.</div>
193
194    </div>
195
196  </body>
197</html>
Note: See TracBrowser for help on using the repository browser.