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

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

update documentation
File size: 4.4 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>monthname.pro (SAXO 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="monthname.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO 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" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../Calendar//monthname.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../idldoc-help.html" 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="leapyr.html">&lt;&lt;prev file</a> | next file &gt;&gt;&nbsp;&nbsp;&nbsp;&nbsp;<a href="monthname.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>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">Calendar/</a></h1>
82      <h2 class="pro_file">monthname.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 gives the name of a month
91</div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_monthname">
105
106          <h2><a class="top" href="#container">top</a>monthname <span class="categories">
107 Calendar,String
108</span></h2>
109       
110          <p class="header">
111            <span class="result">result = </span>monthname(<span class="result"><a href="#_monthname_param_month">month</a></span>, <a href="#_monthname_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
112       
113          <div class="comments">
114</div>
115
116          <h3>Return value</h3><div class="preformat">
117 the month names, a string with the same number of elements than month.
118</div>
119
120         
121            <h3>Parameters</h3>
122       
123           
124            <h4 id="_monthname_param_month">month&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
125              <span class="attr">in</span>
126             
127             
128              <span class="attr">required</span>
129             
130              <span class="attr">type:</span> <span class="value">scalar or array</span>
131             
132             
133            </h4>
134       
135          <div class="comments">
136 the month number (from 1 to 12).
137</div>
138           
139
140         
141
142         
143
144            <h3>Keywords</h3>
145           
146            <h4 id="_monthname_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
147             
148             
149             
150             
151             
152             
153             
154             
155            </h4>
156       
157            <div class="comments">
158 Used to pass keywords to <proidl>string</proidl> function
159</div>
160           
161         
162
163          <h3>Examples</h3><div class="preformat">
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
170</div>
171          <h3>Version history</h3>
172         
173          <h4>Version</h4><div class="preformat">
174 $Id: monthname.pro 327 2007-12-13 16:22:35Z pinsard $
175</div>
176          <h4>History</h4><div class="preformat">
177 Sebastien Masson (smasson@lodyc.jussieu.fr)
178                      1 October 2001
179</div>
180         
181         
182         
183         
184         
185         
186         
187       
188         
189         
190         
191         
192         
193         
194         
195       
196          <h3>Statistics</h3>
197          <table class="statistics">
198            <tr><td>McCabe cyclic</td><td>           1</td></tr>
199            <tr><td>McCabe essential</td><td>           1</td></tr>
200            <tr><td>McCabe modular design</td><td>           1</td></tr>
201          </table>
202         
203       
204        </div>
205       
206      </div>
207
208     
209
210      <div id="tagline">Produced by IDLdoc 2.0.</div>
211
212    </div>
213
214  </body>
215</html>
Note: See TracBrowser for help on using the repository browser.