source: trunk/SRC/Documentation/idldoc_html_output/Utilities/xhelp.html

Last change on this file was 402, checked in by smasson, 15 years ago

update documentation
File size: 5.0 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 (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="xhelp.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="../../../Utilities//xhelp.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="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" 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">Utilities/</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">
90 Display an IDL procedure header using widgets and the widget manager.
91</div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_xhelp">
105
106          <h2><a class="top" href="#container">top</a>xhelp <span class="categories">
107 Utilities Widget
108</span></h2>
109       
110          <p class="header">
111            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>
112       
113          <div class="comments">
114</div>
115
116         
117
118         
119            <h3>Parameters</h3>
120       
121           
122            <h4 id="_xhelp_param_filename">filename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
123              <span class="attr">in</span>
124             
125             
126              <span class="attr">required</span>
127             
128              <span class="attr">type:</span> <span class="value">scalar string</span>
129             
130             
131            </h4>
132       
133          <div class="comments">
134 It is the name of the procedure or of the function
135 we want to display (with or without .pro at the end).
136 FILENAME should be located in !path.
137 ".pro" suffix will be appended if needed.
138</div>
139           
140
141         
142
143         
144
145            <h3>Keywords</h3>
146           
147            <h4 id="_xhelp_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
148             
149             
150             
151             
152             
153             
154             
155             
156            </h4>
157       
158            <div class="comments">
159 Used to pass keywords to <a href="/Applications/itt/idl64/help/online_help/XDISPLAYFILE.html">XDISPLAYFILE</a>
160</div>
161           
162         
163
164          <h3>Examples</h3><div class="preformat">
165
166   IDL> xhelp,'plt'
167</div>
168          <h3>Version history</h3>
169         
170          <h4>Version</h4><div class="preformat">
171 $Id: xhelp.pro 378 2008-08-12 12:35:46Z pinsard $
172</div>
173          <h4>History</h4><div class="preformat">
174 Written By Steve Richards, December 1990
175        Graceful error recovery, DMS, Feb, 1992.
176       Modified to extract .pro documentation headers, PJR/ESRG mar94
177       Paul Ricchiazzi                            jun93
178       Institute for Computational Earth System Science
179       University of California, Santa Barbara
180  - 7/1/99 : legeres modification par Sebastien Masson : utilisation de
181    <a href="/Applications/itt/idl64/help/online_help/XDISPLAYFILE.html">XDISPLAYFILE</a>, de <a href="/Applications/itt/idl64/help/online_help/FINDFILE.html">FINDFILE</a> et de _extra.
182  - 6/7/1999: compatibility mac and windows
183</div>
184         
185         
186          <h3>Known issues</h3>
187         
188         
189         
190          <h4>Restrictions</h4><div class="preformat">
191 Triggers the <a href="/Applications/itt/idl64/help/online_help/XMANAGER.html">XMANAGER</a> if it is not already in use.
192</div>
193       
194         
195         
196         
197         
198         
199         
200         
201       
202          <h3>Statistics</h3>
203          <table class="statistics">
204            <tr><td>McCabe cyclic</td><td>          10</td></tr>
205            <tr><td>McCabe essential</td><td>           1</td></tr>
206            <tr><td>McCabe modular design</td><td>           1</td></tr>
207          </table>
208         
209       
210        </div>
211       
212      </div>
213
214     
215
216      <div id="tagline">Produced by IDLdoc 2.0.</div>
217
218    </div>
219
220  </body>
221</html>
Note: See TracBrowser for help on using the repository browser.