[69] | 1 | <!-- Generated by IDLdoc [% version %] on [% date %] --> |
---|
| 2 | |
---|
| 3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
---|
| 4 | <head> |
---|
| 5 | <title>[% pro_file %] ([% title %])</title> |
---|
| 6 | </head> |
---|
| 7 | |
---|
| 8 | <body text="#000000" bgcolor="#FFFFFF"> |
---|
| 9 | |
---|
| 10 | [% INCLUDE_TEMPLATE navbar_filename %] |
---|
| 11 | |
---|
| 12 | <h1><font size="-2">[% pro_dir %]</font></h1> |
---|
| 13 | <h2>[% pro_file %]</h2> |
---|
| 14 | |
---|
| 15 | <dl> |
---|
| 16 | <dt><b>Last modification:</b></dt> |
---|
| 17 | <dd>[% last_modified %]</dd> |
---|
| 18 | </dl> |
---|
| 19 | |
---|
| 20 | [% file_comments %] |
---|
| 21 | |
---|
| 22 | [% IF nroutines gt 1 %] |
---|
| 23 | <h2>Routine summary</h2> |
---|
| 24 | |
---|
| 25 | <dl> |
---|
| 26 | [% FOREACH r IN routines %][% SCOPE r %] |
---|
| 27 | <dt><a href="[% routine_url %]">[% IF is_func %]<i>result = </i>[% END %][% routine_name %][% IF is_func %]([% END %][% IF nparams gt 0 %]<i>[% FOREACH p IN params %][% SCOPE p %][% IF optional %][[% END %][% delim %][% name %][% IF optional %]][% END %][% END %][% END %]</i>[% END %][% IF nkeywords gt 0 %][% FOREACH k IN keywords %][% SCOPE k %][% IF optional %][[% END %][% delim %][% IF boolean && ~out %]/[% name %][% ELSE %][% name %]=<i>[% out ? "variable" : (type eq '' ? name : type) %]</i>[% END %][% IF optional %]][% END %][% END %][% END %][% END %][% IF is_func %])[% END %]</a><dt> |
---|
| 28 | <dd><font size="-1">[% short_comment %]</font></dd> |
---|
| 29 | [% END %][% END %] |
---|
| 30 | </dl> |
---|
| 31 | |
---|
| 32 | <p> </p> |
---|
| 33 | [% END %] |
---|
| 34 | |
---|
| 35 | [% FOREACH r IN routines %][% SCOPE r %] |
---|
| 36 | <a name="[% routine_url %]"></a> |
---|
| 37 | |
---|
| 38 | <h2>[% routine_name %] [% IF obsolete %]<font size="-1" color="#FF6633">obsolete</font>[% END %][% IF obsolete && private %]<font size="-1" color="#FF6633">, </font>[% END %][% IF private %]<font size="-1" color="#FF6633">private</font>[% END %] [% IF categories_present %]<font size="-1" color="#006633">[% categories %]</font>[% END%]</h2> |
---|
| 39 | |
---|
| 40 | <p><font face="Courier">[% IF is_func %]<i>result = </i>[% END %][% routine_name %][% IF is_func %]([% END %][% IF nparams gt 0 %]<i>[% FOREACH p IN params %][% SCOPE p %][% IF optional %][[% END %][% delim %]<a href="[% routine_url %]_param_[% name %]">[% name %]</a>[% IF optional %]][% END %][% END %][% END %]</i>[% END %][% IF nkeywords gt 0 %][% FOREACH k IN keywords %][% SCOPE k %][% IF optional %][[% END %][% delim %][% IF boolean && ~out %]/<a href="[% routine_url %]_keyword_[% name %]">[% name %]</a>[% ELSE %]<a href="[% routine_url %]_keyword_[% name %]">[% name %]</a>=<i>[% out ? "variable" : (type eq '' ? name : type) %]</i>[% END %][% IF optional %]][% END %][% END %][% END %][% END %][% IF is_func %])[% END %]</font></p> |
---|
| 41 | |
---|
| 42 | [% IF preformat %]<pre>[% END %][% routine_comments %][% IF preformat %]</pre>[% END %] |
---|
| 43 | |
---|
| 44 | [% IF returns_present %]<h3>Return value</h3>[% returns %][% END %] |
---|
| 45 | |
---|
| 46 | [% IF nparams gt 0 %] |
---|
| 47 | <h3>Parameters</h3> |
---|
| 48 | [% FOREACH p IN params %][% SCOPE p %] |
---|
| 49 | |
---|
| 50 | <a name="[% routine_url %]_[% IF keyword %]keyword[% ELSE %]param[% END %]_[% name %]"></a> |
---|
| 51 | <h4>[% name %] |
---|
| 52 | [% IF in %]<font size="-1" color="#006633">in</font>[% END %] |
---|
| 53 | [% IF out %]<font size="-1" color="#006633">out</font>[% END %] |
---|
| 54 | [% IF optional %]<font size="-1" color="#006633">optional</font>[% END %] |
---|
| 55 | [% IF required %]<font size="-1" color="#006633">required</font>[% END %] |
---|
| 56 | [% IF private %]<font size="-1" color="#006633">private</font>[% END %] |
---|
| 57 | [% IF type ne '' %]<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>[% type %]</i></font>[% END %] |
---|
| 58 | [% IF default ne '' %]<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>[% default %]</i></font>[% END %] |
---|
| 59 | [% IF ~comments_present %]<font size="-1" color="#FF6633">undocumented</font>[% END %] |
---|
| 60 | </h4> |
---|
| 61 | |
---|
| 62 | [% comments %] |
---|
| 63 | [% END %][% END %] |
---|
| 64 | [% END %] |
---|
| 65 | |
---|
| 66 | [% IF nkeywords gt 0 %] |
---|
| 67 | <h3>Keywords</h3> |
---|
| 68 | |
---|
| 69 | [% FOREACH k IN keywords %][% SCOPE k %] |
---|
| 70 | <a name="[% routine_url %]_[% IF keyword %]keyword[% ELSE %]param[% END %]_[% name %]"></a> |
---|
| 71 | <h4>[% name %] |
---|
| 72 | [% IF in %]<font size="-1" color="#006633">in</font>[% END %] |
---|
| 73 | [% IF out %]<font size="-1" color="#006633">out</font>[% END %] |
---|
| 74 | [% IF optional %]<font size="-1" color="#006633">optional</font>[% END %] |
---|
| 75 | [% IF required %]<font size="-1" color="#006633">required</font>[% END %] |
---|
| 76 | [% IF private %]<font size="-1" color="#006633">private</font>[% END %] |
---|
| 77 | [% IF type ne '' %]<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>[% type %]</i></font>[% END %] |
---|
| 78 | [% IF default ne '' %]<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>[% default %]</i></font>[% END %] |
---|
| 79 | [% IF ~comments_present %]<font size="-1" color="#FF6633">undocumented</font>[% END %] |
---|
| 80 | </h4> |
---|
| 81 | |
---|
| 82 | [% comments %] |
---|
| 83 | [% END %][% END %] |
---|
| 84 | [% END %] |
---|
| 85 | |
---|
| 86 | [% IF examples_present %]<h3>Examples</h3>[% examples %][% END %] |
---|
| 87 | [% IF author_present || version_present || history_present || copyright_present %]<h3>Version history</h3>[% END %] |
---|
| 88 | [% IF author_present %]<h4>Author</h4>[% author %][% END %] |
---|
| 89 | [% IF version_present %]<h4>Version</h4>[% version %][% END %] |
---|
| 90 | [% IF history_present %]<h4>History</h4>[% history %][% END %] |
---|
| 91 | [% IF copyright_present %]<h4>Copyright</h4>[% copyright %][% END %] |
---|
| 92 | |
---|
| 93 | [% IF obsolete_comments_present || bugs_present || todo_present || restrictions_present %]<h3>Known issues</h3>[% END %] |
---|
| 94 | [% IF obsolete_comments_present %]<h4>Obsolete</h4>[% obsolete_comments %][% END %] |
---|
| 95 | [% IF bugs_present %]<h4>Known bugs</h4>[% bugs %][% END %] |
---|
| 96 | [% IF todo_present %]<h4>Todo items</h4>[% todo %][% END %] |
---|
| 97 | [% IF restrictions_present %]<h4>Restrictions</h4>[% restrictions %][% END %] |
---|
| 98 | |
---|
| 99 | [% IF inherits_present || requires_present || uses_present || precondition_present || postcondition_present || common_blocks_present %]<h3>Other attributes</h3>[% END %] |
---|
| 100 | [% IF inherits_present %]<h4>Inherits classes</h4>[% inherits %][% END %] |
---|
| 101 | [% IF requires_present %]<h4>Requires IDL version</h4>[% requires %][% END %] |
---|
| 102 | [% IF uses_present %]<h4>Uses routines</h4>[% uses %][% END %] |
---|
| 103 | [% IF precondition_present %]<h4>Pre-condition</h4>[% precondition %][% END %] |
---|
| 104 | [% IF postcondition_present %]<h4>Post-condition</h4>[% postcondition %][% END %] |
---|
| 105 | [% IF common_blocks_present %]<h4>Common blocks used</h4>[% common_blocks %][% END %] |
---|
| 106 | |
---|
| 107 | <font size="-3"><p> </p></font> |
---|
| 108 | <hr size="1" color="#CCCCCC"/> |
---|
| 109 | [% END %][% END %] |
---|
| 110 | |
---|
| 111 | [% IF footer NE '' %]<font size="-2"><center>[% INCLUDE footer %]</center></font>[% END %] |
---|
| 112 | |
---|
| 113 | [% INCLUDE_TEMPLATE tagline_filename %] |
---|
| 114 | |
---|
| 115 | </body> |
---|
| 116 | </html> |
---|