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

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

update documentation
File size: 4.2 KB
RevLine 
[89]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>
[104]9    <title>protype.pro (SAXO Documentation)</title>
[89]10
11   
[191]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" />
[89]14   
15
16    <script type="text/javascript">
17      function setTitle() {
[104]18        parent.document.title="protype.pro (SAXO Documentation)";
[89]19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
[104]26  <h1>SAXO Documentation</h1>
[89]27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
[189]35      <td><a href="./../overview.html" title="Overview of library">Overview</a></td>
[89]36     
37
38     
39      <td >Directory</td>
40     
41
42     
[189]43      <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
[89]44     
45
46     
[189]47      <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
[89]48     
49
50     
[189]51      <td><a href="./../search-page.html" title="Search library">Search</a></td>
[89]52     
53
54      <td id="selected">File</td>
55
56     
[189]57      <td><a href="../../../Utilities//protype.pro" title="Source code of a file">Source</a></td>
[89]58     
59
60     
[189]61      <td><a href="./../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
[89]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
[189]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>
[89]75
76</div>
77
78
79    <div id="container">
80
[189]81      <h1 class="directory"><a href="directory-overview.html">Utilities/</a></h1>
[89]82      <h2 class="pro_file">protype.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
[138]89      <div id="file_comments">
90 test is a ".pro" file corresponds to an IDL procedure, function or batch file.
[97]91</div>
[89]92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_protype">
105
[234]106          <h2><a class="top" href="#container">top</a>protype <span class="categories">
[157]107 Utilities
[93]108</span></h2>
[89]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       
[234]113          <div class="comments">
114</div>
[89]115
[234]116          <h3>Return value</h3><div class="preformat">
117 -1 if not found
[138]118 A scalar of string type: 'proc', 'func' or 'batch'
[89]119</div>
120
121         
122            <h3>Parameters</h3>
123       
124           
125            <h4 id="_protype_param_file">file&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[93]126              <span class="attr">in</span>
[89]127             
128             
[234]129              <span class="attr">required</span>
[89]130             
[234]131              <span class="attr">type:</span> <span class="value">string</span>
[89]132             
133             
134            </h4>
135       
[234]136          <div class="comments">
137 the name of the ".pro" file to be tested.
[138]138 if necessary, the input name is completed with '.pro'
139 and its path found in !path
[93]140</div>
[89]141           
142
143         
144
145         
146
[138]147          <h3>Examples</h3><div class="preformat">
[93]148
[402]149   IDL> print, protype('protype')
[93]150      func
[402]151   IDL> print, protype('protype.pro')
[93]152      func
[402]153   IDL> print, protype('init')
[93]154      batch
[402]155   IDL> print, protype('plt')
[93]156      proc
157</div>
158          <h3>Version history</h3>
[89]159         
[234]160          <h4>Version</h4><div class="preformat">
[402]161 $Id: protype.pro 371 2008-08-07 09:32:02Z pinsard $
[242]162</div>
[234]163          <h4>History</h4><div class="preformat">
164 Sebastien Masson (smasson@lodyc.jussieu.fr)
[118]165                       Feb 2006
166</div>
[89]167         
168         
169         
170         
171         
172         
173         
174       
175         
176         
177         
178         
179         
180         
181         
182       
[163]183          <h3>Statistics</h3>
184          <table class="statistics">
185            <tr><td>McCabe cyclic</td><td>           5</td></tr>
186            <tr><td>McCabe essential</td><td>           1</td></tr>
187            <tr><td>McCabe modular design</td><td>           1</td></tr>
188          </table>
[89]189         
190       
191        </div>
192       
193      </div>
194
195     
196
197      <div id="tagline">Produced by IDLdoc 2.0.</div>
198
199    </div>
200
201  </body>
[249]202</html>
Note: See TracBrowser for help on using the repository browser.