source: trunk/SRC/Documentation/idldoc_html_output/Utilities/protype.html @ 104

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

start to modify headers of Postscript *.pro files for better idldoc output + change the title of idldoc output in html to SAXO Documentation
File size: 3.7 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>protype.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="protype.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?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="isafile.html">&lt;&lt;prev file</a> | next file &gt;&gt;&nbsp;&nbsp;&nbsp;&nbsp;<a href="protype.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">Utilities/</a></h1>
82      <h2 class="pro_file">protype.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments"> test is a ".pro" file corresponds to an IDL procedure,
90          function or batch file.
91</div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_protype">
105
106          <h2><a class="top" href="#container">top</a>protype <span class="categories"> utilities
107</span></h2>
108       
109          <p class="header">
110            <span class="result">result = </span>protype(<span class="result"><a href="#_protype_param_file">file</a></span>)</p>
111       
112          <div class="comments"></div>
113
114          <h3>Return value</h3><div class="value"> A scalar of string type: 'proc', 'func' or 'batch'
115</div>
116
117         
118            <h3>Parameters</h3>
119       
120           
121            <h4 id="_protype_param_file">file&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
122              <span class="attr">in</span>
123             
124             
125             
126             
127             
128             
129             
130            </h4>
131       
132          <div class="comments"> A scalar of string type, the name of the ".pro" file to be tested
133    if necessary, the input name is completed with '.pro'
134     and its path found in !path
135</div>
136           
137
138         
139
140         
141
142          <h3>Examples</h3><div class="value"> 
143
144      IDL> print, protype('protype')
145      func
146      IDL> print, protype('protype.pro')
147      func
148      IDL> print, protype('init')
149      batch
150      IDL> print, protype('plt')
151      proc
152</div>
153          <h3>Version history</h3>
154         
155         
156          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr)
157                       Feb 2006</div>
158         
159         
160         
161         
162         
163         
164         
165       
166         
167         
168         
169         
170         
171         
172         
173       
174         
175       
176        </div>
177       
178      </div>
179
180     
181
182      <div id="tagline">Produced by IDLdoc 2.0.</div>
183
184    </div>
185
186  </body>
187</html>
Note: See TracBrowser for help on using the repository browser.