source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/UTILITAIRE/xhelp.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.6 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>xhelp.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="xhelp.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="xfile.html">&lt;&lt;prev file</a> | next file &gt;&gt;&nbsp;&nbsp;&nbsp;&nbsp;<a href="xhelp.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">xhelp.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="_xhelp">
103
104          <h2><a class="top" href="#container">top</a>xhelp </h2>
105       
106          <p class="header">
107            xhelp<span class="result">, <a href="#_xhelp_param_filename">filename</a></span>, <a href="#_xhelp_keyword__extra">_extra</a>=<span class="result">_extra</span></p>
108       
109          <div class="comments">
110 NAME:
111        xhelp
112
113 PURPOSE:
114        Display an IDL procedure header using widgets and the widget manager.
115
116 CATEGORY:
117        Widgets.
118
119 CALLING SEQUENCE:
120        xhelp, Filename,_extra=ex
121
122 INPUTS:
123     Filename:  A scalar string that contains the filename of the file
124                to display.  If FILENAME does not include a complete path
125               specification, xhelp will search for the file in
126               the current working directory and then each of the
127               directories listed in !PATH environment variable.  The
128               ".pro" file suffix will be appended if it is not supplied.
129
130 KEYWORD PARAMETERS:
131       Ceux de xdisplayfile
132
133 OUTPUTS:
134        No explicit outputs.  A file viewing widget is created.
135
136 SIDE EFFECTS:
137        Triggers the XMANAGER if it is not already in use.
138
139 RESTRICTIONS:
140        None.
141
142 PROCEDURE:
143        Open a file and create a widget to display its contents.
144
145 MODIFICATION HISTORY:
146        Written By Steve Richards, December 1990
147        Graceful error recovery, DMS, Feb, 1992.
148       Modified to extract .pro documentation headers, PJR/ESRG mar94
149
150  author:  Paul Ricchiazzi                            jun93
151           Institute for Computational Earth System Science
152           University of California, Santa Barbara
153
154  7/1/99 : legeres mofification par Sebastien Masson : utilisation de
155  xdisplayfile, de findfile et de _extra.
156  6/7/1999: compatibilite mac et windows</div>
157
158         
159
160         
161            <h3>Parameters</h3>
162       
163           
164            <h4 id="_xhelp_param_filename">filename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
165             
166             
167             
168             
169             
170             
171             
172             
173            </h4>
174       
175          <div class="comments"></div>
176           
177
178         
179
180         
181
182            <h3>Keywords</h3>
183           
184            <h4 id="_xhelp_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
185             
186             
187             
188             
189             
190             
191             
192             
193            </h4>
194       
195            <div class="comments"></div>
196           
197         
198
199         
200         
201         
202         
203         
204         
205         
206         
207         
208         
209         
210         
211       
212         
213         
214         
215         
216         
217         
218         
219       
220         
221       
222        </div>
223       
224      </div>
225
226     
227
228      <div id="tagline">Produced by IDLdoc 2.0.</div>
229
230    </div>
231
232  </body>
233</html>
Note: See TracBrowser for help on using the repository browser.