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

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation
File size: 4.6 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>daysinmonth.pro (SAXO Documentation)</title>
[89]10
11   
[191]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" />
[89]14   
15
16    <script type="text/javascript">
17      function setTitle() {
[104]18        parent.document.title="daysinmonth.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     
[189]35      <td><a href="./../overview.html" title="Overview of library">Overview</a></td>
[89]36     
37
38     
39      <td >Directory</td>
40     
41
42     
[189]43      <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
[89]44     
45
46     
[189]47      <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
[89]48     
49
50     
[189]51      <td><a href="./../search-page.html" title="Search library">Search</a></td>
[89]52     
53
54      <td id="selected">File</td>
55
56     
[189]57      <td><a href="../../../Calendar//daysinmonth.pro" title="Source code of a file">Source</a></td>
[89]58     
59
60     
[189]61      <td><a href="./../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
[89]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
[189]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" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
[89]75
76</div>
77
78
79    <div id="container">
80
[189]81      <h1 class="directory"><a href="directory-overview.html">Calendar/</a></h1>
[89]82      <h2 class="pro_file">daysinmonth.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
[138]89      <div id="file_comments">
90 give the number of days in a specific month
[97]91</div>
[89]92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_daysinmonth">
105
[242]106          <h2><a class="top" href="#container">top</a>daysinmonth <span class="categories">
[157]107 Calendar
[93]108</span></h2>
[89]109       
110          <p class="header">
[234]111            <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>
[89]112       
113          <div class="comments">
[93]114</div>
[89]115
[242]116          <h3>Return value</h3><div class="preformat">
[138]117 number of days in a month or -1 in case of error
[89]118</div>
119
120         
121            <h3>Parameters</h3>
122       
123           
124            <h4 id="_daysinmonth_param_month">month&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[234]125              <span class="attr">in</span>
[89]126             
[234]127              <span class="attr">optional</span>
[89]128             
129             
[234]130              <span class="attr">type:</span> <span class="value">integer</span>
[89]131             
132             
133            </h4>
134       
[234]135          <div class="comments">
136 month number
[157]137</div>
[89]138           
139            <h4 id="_daysinmonth_param_year">year&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[93]140              <span class="attr">in</span>
[89]141             
[93]142              <span class="attr">optional</span>
[89]143             
144             
145             
[138]146              <span class="attr">default:</span> <span class="value">from "time" common variable of cm_4cal</span>
[89]147             
148            </h4>
149       
[138]150          <div class="comments">
[163]151 To specify the year of the month. Used only if the common variable
[138]152 key_caltype = 'greg'. In that case, month and year must have the same
153 number of elements.
[93]154</div>
[89]155           
156
157         
158
159         
160
[138]161          <h3>Examples</h3><div class="preformat">
[93]162 IDL> ndays = daysinmonth(2, 2000)
163</div>
164          <h3>Version history</h3>
[89]165         
[242]166          <h4>Version</h4><div class="preformat">
[338]167 $Id: daysinmonth.pro 325 2007-12-06 10:04:53Z pinsard $
[118]168</div>
[242]169          <h4>History</h4><div class="preformat">
[157]170 Sebastien Masson (smasson@lodyc.jussieu.fr)
[138]171 2/7/98
[118]172 update/review/english/new commons: June 2005 Sebastien Masson.
173</div>
[89]174         
175         
176         
177         
178         
179         
180         
181       
[93]182          <h3>Other attributes</h3>
[89]183         
184         
[242]185          <h4>Uses routines</h4><div class="preformat">
186 cm_4cal
187 updatenew
[138]188</div>
[89]189         
190         
191         
192       
[163]193          <h3>Statistics</h3>
194          <table class="statistics">
195            <tr><td>McCabe cyclic</td><td>          11</td></tr>
196            <tr><td>McCabe essential</td><td>           1</td></tr>
197            <tr><td>McCabe modular design</td><td>           1</td></tr>
198          </table>
[89]199         
200       
201        </div>
202       
203      </div>
204
205     
206
207      <div id="tagline">Produced by IDLdoc 2.0.</div>
208
209    </div>
210
211  </body>
[249]212</html>
Note: See TracBrowser for help on using the repository browser.