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

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

remove format=raw in all html files 2+ : correction for all_plots; suppression of css and correction of Source links in idldoc html output
File size: 4.1 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" 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//protype.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="mergeonline_help.html">&lt;&lt;prev file</a> | <a href="pwd.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="protype.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">protype.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 test is a ".pro" file corresponds to an IDL procedure, 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"> 
107 Utilities
108</span></h2>
109       
110          <p class="header">
111            <span class="result">result = </span>protype(<span class="result"><a href="#_protype_param_file">file</a></span>)</p>
112       
113          <div class="comments"></div>
114
115          <h3>Return value</h3><div class="preformat"> 
116 A scalar of string type: 'proc', 'func' or 'batch'
117</div>
118
119         
120            <h3>Parameters</h3>
121       
122           
123            <h4 id="_protype_param_file">file&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
124              <span class="attr">in</span>
125             
126             
127             
128             
129             
130             
131             
132            </h4>
133       
134          <div class="comments"> 
135 A scalar of string type, the name of the ".pro" file to be tested
136 if necessary, the input name is completed with '.pro'
137 and its path found in !path
138</div>
139           
140
141         
142
143         
144
145          <h3>Examples</h3><div class="preformat">
146
147 IDL> print, protype('protype')
148      func
149 IDL> print, protype('protype.pro')
150      func
151 IDL> print, protype('init')
152      batch
153 IDL> print, protype('plt')
154      proc
155</div>
156          <h3>Version history</h3>
157         
158          <h4>Version</h4><div class="preformat"> $Id: protype.pro 163 2006-08-29 12:59:46Z navarro $</div>
159          <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr)
160                       Feb 2006
161</div>
162         
163         
164         
165         
166         
167         
168         
169       
170         
171         
172         
173         
174         
175         
176         
177       
178          <h3>Statistics</h3>
179          <table class="statistics">
180            <tr><td>McCabe cyclic</td><td>           5</td></tr>
181            <tr><td>McCabe essential</td><td>           1</td></tr>
182            <tr><td>McCabe modular design</td><td>           1</td></tr>
183          </table>
184         
185       
186        </div>
187       
188      </div>
189
190     
191
192      <div id="tagline">Produced by IDLdoc 2.0.</div>
193
194    </div>
195
196  </body>
197</html>
Note: See TracBrowser for help on using the repository browser.