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 | <!-- Template needs structure with the following fields: |
---|
6 | version : IDLdoc version |
---|
7 | date : string containing date of file creation |
---|
8 | embed : 0 for link to CSS, 1 for embed CSS |
---|
9 | css_location : if embed then string filename of CSS file location, o/w href to CSS file |
---|
10 | navbar_filename : filename of navbar template |
---|
11 | footer : filename of footer file to include |
---|
12 | tagline_filename : filename of tagline template |
---|
13 | Plus fields needed by the templates: navbar, tagline |
---|
14 | --> |
---|
15 | |
---|
16 | <!-- Generated by IDLdoc [% version %] on [% date %] --> |
---|
17 | |
---|
18 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
---|
19 | <head> |
---|
20 | <title>IDLdoc Help ([% title %])</title> |
---|
21 | |
---|
22 | [% IF embed %] |
---|
23 | <style type="text/css" media="all"> |
---|
24 | [% INCLUDE css_location %] |
---|
25 | </style> |
---|
26 | <style type="text/css" media="print"> |
---|
27 | [% INCLUDE print_css_location %] |
---|
28 | </style> |
---|
29 | [% ELSE %] |
---|
30 | <link rel="stylesheet" type="text/css" href="[% root %]/main_files.css" media="all"/> |
---|
31 | <link rel="stylesheet" type="text/css" href="[% root %]/main_files_print.css" media="print"/> |
---|
32 | [% END %] |
---|
33 | |
---|
34 | <script type="text/javascript"> |
---|
35 | function setTitle() { |
---|
36 | parent.document.title="Help ([% title %])"; |
---|
37 | } |
---|
38 | </script> |
---|
39 | </head> |
---|
40 | |
---|
41 | <body onload="setTitle();"> |
---|
42 | |
---|
43 | [% INCLUDE_TEMPLATE navbar_filename %] |
---|
44 | |
---|
45 | <div id="container"> |
---|
46 | |
---|
47 | <div class="toc small"> |
---|
48 | <ol class="toc"> |
---|
49 | <li><a href="idldoc-help.html">Help for users of an IDLdoc'ed library</a></li> |
---|
50 | <li><a href="idldoc-dev-help.html">Basic markup of code</a></li> |
---|
51 | <li><a href="idldoc-dev-help2.html">Modifying IDLdoc output</a></li> |
---|
52 | </ol> |
---|
53 | </div> |
---|
54 | |
---|
55 | <h1>Help on IDLdoc output</h1> |
---|
56 | |
---|
57 | <p>The following information is provides documentation in |
---|
58 | interpreting the results of the output of IDLdoc. For |
---|
59 | documentation on marking up IDL code to better use IDLdoc's |
---|
60 | capabilities, see the <a href="idldoc-dev-help.html">developer's |
---|
61 | help</a> or the <a href="idldoc-dev-help2.html">advanced developer's help</a>.</p> |
---|
62 | |
---|
63 | <h2>File summary</h2> |
---|
64 | |
---|
65 | <p>The file summary includes a the class hierarchy diagram for |
---|
66 | files with names ending in __define, a list of various |
---|
67 | attributes of the file, and a description.</p> |
---|
68 | |
---|
69 | <h2>Field summary</h2> |
---|
70 | |
---|
71 | <p>If the filename of PRO file ends in __define, then the fields |
---|
72 | defined in the routine of the same name are listed with their |
---|
73 | type and any comments provided by the developer. Following this |
---|
74 | listing are separate listings for each parent class of the |
---|
75 | class/structure with a list of their fields with types.</p> |
---|
76 | |
---|
77 | <h2>Routine summary</h2> |
---|
78 | |
---|
79 | <p>The routine summary simply provides the calling sequence for |
---|
80 | each routine in the file (in the same syntax is the online help |
---|
81 | for IDL) and the first sentence of the detailed description for |
---|
82 | each routine in the file.</p> |
---|
83 | |
---|
84 | <h2>Routine details</h2> |
---|
85 | |
---|
86 | <p>The routine details sections gives a possibly longer |
---|
87 | description of the routine as well as a tables of the parameters |
---|
88 | and keywords accepted by the routine. Also listed are various |
---|
89 | attributes of the routine.</p> |
---|
90 | |
---|
91 | <p>All the parameters and keywords of the routine will be in |
---|
92 | these tables regardless if they have been commented using IDLdoc |
---|
93 | (though the developer can hide parameters and keywords if they |
---|
94 | chose).</p> |
---|
95 | |
---|
96 | <h3>Routine attributes</h3> |
---|
97 | |
---|
98 | <p>A routine can be marked with various attributes described in |
---|
99 | the below table.</p> |
---|
100 | |
---|
101 | <table class="basic" cellspacing="0"> |
---|
102 | <tr> |
---|
103 | <th>Attribute</th> |
---|
104 | <th>Description</th> |
---|
105 | </tr> |
---|
106 | <tr> |
---|
107 | <td><h2 style="padding-top: 0; margin-top: 0.1em;"><span class="warning">abstract</span></h2></td> |
---|
108 | <td> |
---|
109 | The routine name will be italicized if the routine is |
---|
110 | marked "abstract" (meaning it is not implemented, it is |
---|
111 | provided for its interface only). This is generally used |
---|
112 | in only object-oriented programming. |
---|
113 | </td> |
---|
114 | </tr> |
---|
115 | <tr> |
---|
116 | <td><h2 style="padding-top: 0; margin-top: 0.1em;"><span class="warning">private</span></h2></td> |
---|
117 | <td> |
---|
118 | This routine is not intended to be called except by other |
---|
119 | routines in the same file. In other words it is a "helper |
---|
120 | routine". Private routines are only seen if the library is |
---|
121 | IDLdoc'ed in "developer" mode. |
---|
122 | </td> |
---|
123 | </tr> |
---|
124 | <tr> |
---|
125 | <td><h2 style="padding-top: 0; margin-top: 0.1em;"><span class="warning">obsolete</span></h2></td> |
---|
126 | <td> |
---|
127 | This routine is no longer supported by the library |
---|
128 | maintainer. |
---|
129 | </td> |
---|
130 | </tr> |
---|
131 | <tr> |
---|
132 | <td><h2 style="padding-top: 0; margin-top: 0.1em;"><span class="categories">categories</span></h2></td> |
---|
133 | <td> |
---|
134 | The names of any categories for the routine are listed. |
---|
135 | </td> |
---|
136 | </tr> |
---|
137 | </table> |
---|
138 | |
---|
139 | <h3>Parameter and keyword attributes</h3> |
---|
140 | |
---|
141 | <p>A parameter or keyword can be marked with various attributes |
---|
142 | described in the below table.</p> |
---|
143 | |
---|
144 | <table class="basic" cellspacing="0"> |
---|
145 | <tr> |
---|
146 | <th>Attribute</th> |
---|
147 | <th>Description</th> |
---|
148 | </tr> |
---|
149 | <tr> |
---|
150 | <td><span class="attr">in</span></td> |
---|
151 | <td> |
---|
152 | Indicates that the argument is intended to be passed into |
---|
153 | the routine. |
---|
154 | </td> |
---|
155 | </tr> |
---|
156 | <tr> |
---|
157 | <td><span class="attr">out</span></td> |
---|
158 | <td> |
---|
159 | Indicates that the argument is intended to be used to pass |
---|
160 | a value out of the routine. A named variable must be |
---|
161 | passed to the routine to pass a value back to the calling |
---|
162 | level. |
---|
163 | </td> |
---|
164 | </tr> |
---|
165 | <tr> |
---|
166 | <td><span class="attr">optional</span></td> |
---|
167 | <td> |
---|
168 | This attribute indicates the argument is optional; |
---|
169 | optional parameters and keywords are also placed inside |
---|
170 | brackets ([]) in the routine summary. |
---|
171 | </td> |
---|
172 | </tr> |
---|
173 | <tr> |
---|
174 | <td><span class="attr">required</span></td> |
---|
175 | <td>Indicates the argument is required</td> |
---|
176 | </tr> |
---|
177 | <tr> |
---|
178 | <td><span class="attr">type</span></td> |
---|
179 | <td> |
---|
180 | Type indicates the IDL type of the variable. Can be used |
---|
181 | indicate a group of types, a specific type, an array of a |
---|
182 | certain type, etc. Boolean keywords are indicated by a |
---|
183 | /KEYWORD_NAME in the routine summary. |
---|
184 | </td> |
---|
185 | </tr> |
---|
186 | <tr> |
---|
187 | <td><span class="attr">default</span></td> |
---|
188 | <td> |
---|
189 | Default indicates the default value for an optional |
---|
190 | parameter or keyword. |
---|
191 | </td> |
---|
192 | </tr> |
---|
193 | <tr> |
---|
194 | <td><span class="attr">private</span></td> |
---|
195 | <td> |
---|
196 | This parameter is not intended to be used in calls except |
---|
197 | by other routines in the same file. Private parameters are |
---|
198 | only seen if the library is IDLdoc'ed in "developer" mode. |
---|
199 | </td> |
---|
200 | </tr> |
---|
201 | </table> |
---|
202 | |
---|
203 | [% IF footer NE '' %]<div id="footer">[% INCLUDE footer %]</div>[% END %] |
---|
204 | |
---|
205 | [% INCLUDE_TEMPLATE tagline_filename %] |
---|
206 | |
---|
207 | </div> |
---|
208 | </body> |
---|
209 | </html> |
---|
210 | |
---|