source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/UTILITAIRE/routine_name.html @ 89

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

add idldoc html output. see Documentation/idldoc_html_output/index.html
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>routine_name.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="routine_name.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="report.html">&lt;&lt;prev file</a> | <a href="test.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="routine_name.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">ToBeReviewed/UTILITAIRE/</a></h1>
82      <h2 class="pro_file">routine_name.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="_routine_name">
103
104          <h2><a class="top" href="#container">top</a>routine_name </h2>
105       
106          <p class="header">
107            <span class="result">result = </span>routine_name(<span class="result"><a href="#_routine_name_param_remonte">remonte</a></span>)</p>
108       
109          <div class="comments">
110 NAME:routine_name,remonte
111
112 PURPOSE:retourne le nom de la routine (procedure ou function) ds
113 lequel on se trouve
114
115 CATEGORY:utilitaire
116
117 CALLING SEQUENCE:res=routine_name([remonte])
118 
119 INPUTS: remonte: un entier qui donne de combien de niveau on doit
120 remonter ds l''empillement des routines ewt sous-routines pour
121 retrouver le nom de la routine cherchee
122
123 KEYWORD PARAMETERS:
124
125 OUTPUTS:un string donnant soit le nom de la routine en entier (avec
126 le path) soit '$MAIN$'
127
128 COMMON BLOCKS:
129
130 SIDE EFFECTS:
131
132 RESTRICTIONS:
133   cette fonction utilise le mot cle OUTPUT ds help.pro et il est
134   specifie ds l''aide en ligne que la syntaxe du retour de ce mot cle
135   peut changer suivant la version du code. Cette version marche avec
136   IDL 5.2
137
138 EXAMPLE:
139
140  IDL> print, routine_name()
141  /usr1/com/smasson/IDL_RD/UTILITAIRE/report.pro
142  IDL> print, routine_name(1)
143  /usr1/com/smasson/IDL_RD/PLOTS/DIVERS/determineminmax.pro
144  IDL> print, routine_name(2)
145  /usr1/com/smasson/IDL_RD/PLOTS/DESSINE/plt.pro
146  IDL> print, routine_name(3)
147  $MAIN$
148  IDL> print, routine_name(4)
149  $MAIN$
150</div>
151
152         
153
154         
155            <h3>Parameters</h3>
156       
157           
158            <h4 id="_routine_name_param_remonte">remonte&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
159             
160             
161             
162             
163             
164             
165             
166             
167            </h4>
168       
169          <div class="comments"></div>
170           
171
172         
173
174         
175
176         
177         
178         
179         
180         
181         
182         
183         
184         
185         
186         
187         
188       
189         
190         
191         
192         
193         
194         
195         
196       
197         
198       
199        </div>
200       
201      </div>
202
203     
204
205      <div id="tagline">Produced by IDLdoc 2.0.</div>
206
207    </div>
208
209  </body>
210</html>
Note: See TracBrowser for help on using the repository browser.