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 [% version %] on [% date %] --> |
---|
6 | |
---|
7 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
---|
8 | <head> |
---|
9 | <title>[% pro_file %] ([% title %])</title> |
---|
10 | |
---|
11 | [% IF embed %] |
---|
12 | <style type="text/css" media="all"> |
---|
13 | [% INCLUDE css_location %] |
---|
14 | </style> |
---|
15 | <style type="text/css" media="print"> |
---|
16 | [% INCLUDE print_css_location %] |
---|
17 | </style> |
---|
18 | [% ELSE %] |
---|
19 | <link rel="stylesheet" type="text/css" media="all" href="[% root %]main_files.css" /> |
---|
20 | <link rel="stylesheet" type="text/css" media="print" href="[% root %]main_files_print.css" /> |
---|
21 | [% END %] |
---|
22 | |
---|
23 | <script type="text/javascript"> |
---|
24 | function setTitle() { |
---|
25 | parent.document.title="[% pro_file %] ([% title %])"; |
---|
26 | } |
---|
27 | </script> |
---|
28 | </head> |
---|
29 | |
---|
30 | <body onload="setTitle();"> |
---|
31 | |
---|
32 | [% INCLUDE_TEMPLATE navbar_filename %] |
---|
33 | |
---|
34 | <div id="container"> |
---|
35 | |
---|
36 | <h1 class="directory"><a href="directory-overview.html">[% pro_dir %]</a></h1> |
---|
37 | <h2 class="pro_file">[% pro_file %]</h2> |
---|
38 | |
---|
39 | <div id="file_attr"> |
---|
40 | <dl> |
---|
41 | <dt>Last modification:</dt> |
---|
42 | <dd>[% last_modified %]</dd> |
---|
43 | </dl> |
---|
44 | </div> |
---|
45 | |
---|
46 | <div id="file_comments">[% file_comments %]</div> |
---|
47 | |
---|
48 | [% IF is_class %][% SCOPE class %] |
---|
49 | [% IF has_superclasses %]<div id="class_diagram">[% hierarchy %]</div>[% END %] |
---|
50 | |
---|
51 | [% IF has_subclasses %]<div class="field_summary"> |
---|
52 | <h2>Direct known subclasses</h2> |
---|
53 | |
---|
54 | <p class="commaList"> |
---|
55 | [% FOREACH sub IN direct_subclasses %][% SCOPE sub %][% IF ~first_subclass %], [% END %][% IF url ne '' %]<a href="[% url %]">[% classname %]</a>[% ELSE %][% classname %][% END %][% END %][% END %] |
---|
56 | </p> |
---|
57 | |
---|
58 | </div>[% END %] |
---|
59 | [% END %][% END %] |
---|
60 | |
---|
61 | [% IF has_fields and not user %] |
---|
62 | <div class="field_summary" id="field_summary"> |
---|
63 | <h2>Field summary</h2> |
---|
64 | |
---|
65 | <table> |
---|
66 | [% FOREACH f IN fields %][% SCOPE f %] |
---|
67 | <tr><td class="name">[% name %]<br/><span class="field_type">[% type %]</span></td><td class="comments">[% comments %]</td></tr> |
---|
68 | [% END %][% END %] |
---|
69 | </table> |
---|
70 | </div> |
---|
71 | [% END %] |
---|
72 | |
---|
73 | [% IF is_class and not user %][% SCOPE class %] |
---|
74 | [% IF has_superclasses %] |
---|
75 | [% FOREACH sc IN all_superclasses %][% SCOPE sc %] |
---|
76 | <div class="field_summary"> |
---|
77 | <h2>Fields for [% classname %]</h2> |
---|
78 | |
---|
79 | [% IF nfields gt 0 %] |
---|
80 | <table> |
---|
81 | [% FOREACH flds IN fields %][% SCOPE flds %] |
---|
82 | <tr><td class="name">[% name %] <span class="field_type">[% type %]</span></td></tr> |
---|
83 | [% END %][% END %] |
---|
84 | </table> |
---|
85 | [% ELSE %] |
---|
86 | <p>No known fields.</p> |
---|
87 | [% END %] |
---|
88 | </div> |
---|
89 | [% END %][% END %] |
---|
90 | [% END %] |
---|
91 | [% END %][% END %] |
---|
92 | |
---|
93 | [% IF nroutines gt 1 %] |
---|
94 | <div id="routine_summary"> |
---|
95 | <h2>Routine summary</h2> |
---|
96 | |
---|
97 | <dl> |
---|
98 | [% FOREACH r IN routines %][% SCOPE r %] |
---|
99 | <dt><p><a href="#_[% routine_name %]">[% IF is_func %]<span class="result">result = </span>[% END %][% routine_name %][% IF is_func %]([% END %][% IF nparams gt 0 %]<span class="result">[% FOREACH p IN params %][% SCOPE p %][% IF optional %][[% END %][% delim %][% name %][% IF optional %]][% END %][% END %][% END %]</span>[% END %][% IF nkeywords gt 0 %][% FOREACH k IN keywords %][% SCOPE k %][% IF optional %][[% END %][% delim %][% IF boolean && ~out %]/[% name %][% ELSE %][% name %]=<span class="result">[% out ? "variable" : (type eq '' ? name : type) %]</span>[% END %][% IF optional %]][% END %][% END %][% END %][% END %][% IF is_func %])[% END %]</a></p><dt> |
---|
100 | <dd>[% short_comment %]</dd> |
---|
101 | [% END %][% END %] |
---|
102 | </dl> |
---|
103 | </div> |
---|
104 | [% END %] |
---|
105 | |
---|
106 | <div id="routine_details"> |
---|
107 | [% FOREACH r IN routines %][% SCOPE r %] |
---|
108 | |
---|
109 | <div class="routine_details" id="_[% routine_name %]"> |
---|
110 | |
---|
111 | <h2><a class="top" href="#container">top</a>[% routine_name %] [% IF obsolete %]<span class="warning">obsolete</span> [% END %][% IF abstract %]<span class="warning">abstract</span> [% END %][% IF private %]<span class="warning">private</span> [% END %][% IF categories_present %]<span class="categories">[% categories %]</span>[% END%]</h2> |
---|
112 | |
---|
113 | <p class="header"> |
---|
114 | [% IF is_func %]<span class="result">result = </span>[% END %][% routine_name %][% IF is_func %]([% END %][% IF nparams gt 0 %]<span class="result">[% FOREACH p IN params %][% SCOPE p %][% IF optional %][[% END %][% delim %]<a href="#_[% routine_name %]_param_[% name %]">[% name %]</a>[% IF optional %]][% END %][% END %][% END %]</span>[% END %][% IF nkeywords gt 0 %][% FOREACH k IN keywords %][% SCOPE k %][% IF optional %][[% END %][% delim %][% IF boolean && ~out %]/<a href="#_[% routine_name %]_keyword_[% name %]">[% name %]</a>[% ELSE %]<a href="#_[% routine_name %]_keyword_[% name %]">[% name %]</a>=<span class="result">[% out ? "variable" : (type eq '' ? name : type) %]</span>[% END %][% IF optional %]][% END %][% END %][% END %][% END %][% IF is_func %])[% END %]</p> |
---|
115 | |
---|
116 | <div class="comments[% IF preformat %] preformat[% END %]">[% routine_comments %]</div> |
---|
117 | |
---|
118 | [% IF returns_present %]<h3>Return value</h3><div class="value">[% returns %]</div>[% END %] |
---|
119 | |
---|
120 | [% IF nparams gt 0 %] |
---|
121 | <h3>Parameters</h3> |
---|
122 | |
---|
123 | [% FOREACH p IN params %][% SCOPE p %] |
---|
124 | <h4 id="_[% routine_name %]_param_[% name %]">[% name %] |
---|
125 | [% IF in %]<span class="attr">in</span>[% END %] |
---|
126 | [% IF out %]<span class="attr">out</span>[% END %] |
---|
127 | [% IF optional %]<span class="attr">optional</span>[% END %] |
---|
128 | [% IF required %]<span class="attr">required</span>[% END %] |
---|
129 | [% IF private %]<span class="attr">private</span>[% END %] |
---|
130 | [% IF type ne '' %]<span class="attr">type:</span> <span class="value">[% type %]</span>[% END %] |
---|
131 | [% IF default ne '' %]<span class="attr">default:</span> <span class="value">[% default %]</span>[% END %] |
---|
132 | [% IF ~comments_present %]<span class="undoc">undocumented</span>[% END %] |
---|
133 | </h4> |
---|
134 | |
---|
135 | <div class="comments">[% comments %]</div> |
---|
136 | [% END %][% END %] |
---|
137 | |
---|
138 | [% END %] |
---|
139 | |
---|
140 | [% IF nkeywords gt 0 %] |
---|
141 | |
---|
142 | <h3>Keywords</h3> |
---|
143 | [% FOREACH k IN keywords %][% SCOPE k %] |
---|
144 | <h4 id="_[% routine_name %]_keyword_[% name %]">[% name %] |
---|
145 | [% IF in %]<span class="attr">in</span>[% END %] |
---|
146 | [% IF out %]<span class="attr">out</span>[% END %] |
---|
147 | [% IF optional %]<span class="attr">optional</span>[% END %] |
---|
148 | [% IF required %]<span class="attr">required</span>[% END %] |
---|
149 | [% IF private %]<span class="attr">private</span>[% END %] |
---|
150 | [% IF type ne '' %]<span class="attr">type:</span> <span class="value">[% type %]</span>[% END %] |
---|
151 | [% IF default ne '' %]<span class="attr">default:</span> <span class="value">[% default %]</span>[% END %] |
---|
152 | [% IF ~comments_present %]<span class="undoc">undocumented</span>[% END %] |
---|
153 | </h4> |
---|
154 | |
---|
155 | <div class="comments">[% comments %]</div> |
---|
156 | [% END %][% END %] |
---|
157 | [% END %] |
---|
158 | |
---|
159 | [% IF examples_present %]<h3>Examples</h3><div class="value">[% examples %]</div>[% END %] |
---|
160 | [% IF author_present || version_present || history_present || copyright_present || customer_id_present %]<h3>Version history</h3>[% END %] |
---|
161 | [% IF author_present %]<h4>Author</h4><div class="value">[% author %]</div>[% END %] |
---|
162 | [% IF version_present %]<h4>Version</h4><div class="value">[% version %]</div>[% END %] |
---|
163 | [% IF history_present %]<h4>History</h4><div class="value">[% history %]</div>[% END %] |
---|
164 | [% IF copyright_present %]<h4>Copyright</h4><div class="value">[% copyright %]</div>[% END %] |
---|
165 | [% IF customer_id_present %]<h4>Customer ID</h4><div class="value">[% customer_id %]</div>[% END %] |
---|
166 | [% IF obsolete_comments_present || bugs_present || todo_present || restrictions_present %]<h3>Known issues</h3>[% END %] |
---|
167 | [% IF obsolete_comments_present %]<h4>Obsolete</h4><div class="value">[% obsolete_comments %]</div>[% END %] |
---|
168 | [% IF bugs_present %]<h4>Known bugs</h4><div class="value">[% bugs %]</div>[% END %] |
---|
169 | [% IF todo_present %]<h4>Todo items</h4><div class="value">[% todo %]</div>[% END %] |
---|
170 | [% IF restrictions_present %]<h4>Restrictions</h4><div class="value">[% restrictions %]</div>[% END %] |
---|
171 | |
---|
172 | [% IF inherits_present || requires_present || uses_present || precondition_present || postcondition_present || common_blocks_present %]<h3>Other attributes</h3>[% END %] |
---|
173 | [% IF inherits_present %]<h4>Inherits classes</h4><div class="value">[% inherits %]</div>[% END %] |
---|
174 | [% IF requires_present %]<h4>Requires IDL version</h4><div class="value">[% requires %]</div>[% END %] |
---|
175 | [% IF uses_present %]<h4>Uses routines</h4><div class="value">[% uses %]</div>[% END %] |
---|
176 | [% IF precondition_present %]<h4>Pre-condition</h4><div class="value">[% precondition %]</div>[% END %] |
---|
177 | [% IF postcondition_present %]<h4>Post-condition</h4><div class="value">[% postcondition %]</div>[% END %] |
---|
178 | [% IF common_blocks_present %]<h4>Common blocks used</h4><div class="value">[% common_blocks %]</div>[% END %] |
---|
179 | |
---|
180 | [% IF statistics %]<h3>Statistics</h3> |
---|
181 | <table class="statistics"> |
---|
182 | <tr><td>McCabe cyclic</td><td>[% mccabe_cyclic %]</td></tr> |
---|
183 | <tr><td>McCabe essential</td><td>[% mccabe_essential %]</td></tr> |
---|
184 | <tr><td>McCabe modular design</td><td>[% mccabe_mod_design %]</td></tr> |
---|
185 | </table> |
---|
186 | [% END %][% END %] |
---|
187 | |
---|
188 | </div> |
---|
189 | [% END %] |
---|
190 | </div> |
---|
191 | |
---|
192 | [% IF footer ne '' %]<div id="footer">[% INCLUDE footer %]</div>[% END %] |
---|
193 | |
---|
194 | [% INCLUDE_TEMPLATE tagline_filename %] |
---|
195 | |
---|
196 | </div> |
---|
197 | |
---|
198 | </body> |
---|
199 | </html> |
---|