[% INCLUDE_TEMPLATE navbar_filename %]
[% pro_dir %]
[% pro_file %]
- Last modification:
- [% last_modified %]
[% file_comments %]
[% IF nroutines gt 1 %]
Routine summary
[% FOREACH r IN routines %][% SCOPE r %]
- [% IF is_func %]result = [% END %][% routine_name %][% IF is_func %]([% END %][% IF nparams gt 0 %][% FOREACH p IN params %][% SCOPE p %][% IF optional %][[% END %][% delim %][% name %][% IF optional %]][% END %][% END %][% END %][% END %][% IF nkeywords gt 0 %][% FOREACH k IN keywords %][% SCOPE k %][% IF optional %][[% END %][% delim %][% IF boolean && ~out %]/[% name %][% ELSE %][% name %]=[% out ? "variable" : (type eq '' ? name : type) %][% END %][% IF optional %]][% END %][% END %][% END %][% END %][% IF is_func %])[% END %]
-
- [% short_comment %]
[% END %][% END %]
[% END %]
[% FOREACH r IN routines %][% SCOPE r %]
[% routine_name %] [% IF obsolete %]obsolete[% END %][% IF obsolete && private %], [% END %][% IF private %]private[% END %] [% IF categories_present %][% categories %][% END%]
[% IF is_func %]result = [% END %][% routine_name %][% IF is_func %]([% END %][% IF nparams gt 0 %][% FOREACH p IN params %][% SCOPE p %][% IF optional %][[% END %][% delim %][% name %][% IF optional %]][% END %][% END %][% END %][% END %][% IF nkeywords gt 0 %][% FOREACH k IN keywords %][% SCOPE k %][% IF optional %][[% END %][% delim %][% IF boolean && ~out %]/[% name %][% ELSE %][% name %]=[% out ? "variable" : (type eq '' ? name : type) %][% END %][% IF optional %]][% END %][% END %][% END %][% END %][% IF is_func %])[% END %]
[% IF preformat %][% END %][% routine_comments %][% IF preformat %]
[% END %]
[% IF returns_present %]Return value
[% returns %][% END %]
[% IF nparams gt 0 %]
Parameters
[% FOREACH p IN params %][% SCOPE p %]
[% name %]
[% IF in %]in[% END %]
[% IF out %]out[% END %]
[% IF optional %]optional[% END %]
[% IF required %]required[% END %]
[% IF private %]private[% END %]
[% IF type ne '' %]type: [% type %][% END %]
[% IF default ne '' %]default: [% default %][% END %]
[% IF ~comments_present %]undocumented[% END %]
[% comments %]
[% END %][% END %]
[% END %]
[% IF nkeywords gt 0 %]
Keywords
[% FOREACH k IN keywords %][% SCOPE k %]
[% name %]
[% IF in %]in[% END %]
[% IF out %]out[% END %]
[% IF optional %]optional[% END %]
[% IF required %]required[% END %]
[% IF private %]private[% END %]
[% IF type ne '' %]type: [% type %][% END %]
[% IF default ne '' %]default: [% default %][% END %]
[% IF ~comments_present %]undocumented[% END %]
[% comments %]
[% END %][% END %]
[% END %]
[% IF examples_present %]Examples
[% examples %][% END %]
[% IF author_present || version_present || history_present || copyright_present %]Version history
[% END %]
[% IF author_present %]Author
[% author %][% END %]
[% IF version_present %]Version
[% version %][% END %]
[% IF history_present %]History
[% history %][% END %]
[% IF copyright_present %]Copyright
[% copyright %][% END %]
[% IF obsolete_comments_present || bugs_present || todo_present || restrictions_present %]Known issues
[% END %]
[% IF obsolete_comments_present %]Obsolete
[% obsolete_comments %][% END %]
[% IF bugs_present %]Known bugs
[% bugs %][% END %]
[% IF todo_present %]Todo items
[% todo %][% END %]
[% IF restrictions_present %]Restrictions
[% restrictions %][% END %]
[% IF inherits_present || requires_present || uses_present || precondition_present || postcondition_present || common_blocks_present %]Other attributes
[% END %]
[% IF inherits_present %]Inherits classes
[% inherits %][% END %]
[% IF requires_present %]Requires IDL version
[% requires %][% END %]
[% IF uses_present %]Uses routines
[% uses %][% END %]
[% IF precondition_present %]Pre-condition
[% precondition %][% END %]
[% IF postcondition_present %]Post-condition
[% postcondition %][% END %]
[% IF common_blocks_present %]Common blocks used
[% common_blocks %][% END %]
[% END %][% END %]
[% IF footer NE '' %][% INCLUDE footer %][% END %]
[% INCLUDE_TEMPLATE tagline_filename %]