[% IF has_comments %]
[% comments %]
[% END %] [% IF has_examples %]

Examples

[% examples %]
[% END %] [% IF has_class %][% FOREACH class IN classes %][% SCOPE class %]

Class description for [% classname %]

[% IF n_ancestors gt 0 %]

Inheritance

[% IF n_ancestors gt n_parents %]

All ancestor classes: [% FOREACH a IN ancestors %] [% IF a->hasUrl() %][% END %][% a->getClassname() %][% IF a->hasUrl() %][% END %] [% END %]

[% END %] [% END %] [% IF n_children gt 0 %]

Subclasses: [% FOREACH c IN children %] [% IF c->hasUrl() %][% END %][% c->getClassname() %][% IF c->hasUrl() %][% END %] [% END %]

[% END %] [% IF n_visible_properties gt 0 || n_visible_parent_properties gt 0 %]

Properties

[% IF n_ancestors gt 0 && ~user %] [% FOREACH a IN ancestors %][% SCOPE a %] [% IF n_visible_properties gt 0 %]

Properties in [% IF has_url %][% END %][% classname %][% IF has_url %][% END %]

[% END %] [% END %][% END %] [% END %] [% IF n_visible_properties gt 0 %]

Properties in [% classname %]

[% FOREACH p IN visible_properties %][% SCOPE p %]
[% name %] [% IF is_get %]get [% END %][% IF is_set %]set [% END %][% IF is_init %]init [% END %][% IF has_type %]type=[% type %][% END %]
[% comments %]
[% END %][% END %]
[% END %] [% END %] [% IF (n_fields gt 0 || n_parent_fields gt 0) && ~user %]

Fields

[% IF n_ancestors gt 0 && ~user %] [% FOREACH a IN ancestors %][% SCOPE a %] [% IF n_fields gt 0 %]

Fields in [% IF has_url %][% END %][% classname %][% IF has_url %][% END %]

[% END %] [% END %][% END %] [% END %] [% IF n_fields gt 0 %]

Fields in [% classname %]

[% FOREACH f IN fields %][% SCOPE f %]
[% name %] [% type %]
[% comments %]
[% END %][% END %]
[% END %] [% END %]
[% END %][% END %][% END %] [% IF has_author_info %]

Author information

[% IF has_author %]
Author
[% author %]
[% END %] [% IF has_copyright %]
Copyright
[% copyright %]
[% END %] [% IF has_history %]
History
[% history %]
[% END %] [% IF has_version %]
Version
[% version %]
[% END %]
[% END %] [% IF has_others %]

Other file information

[% IF has_bugs %]
Bugs:
[% bugs %]
[% END %] [% IF has_customer_id %]
Customer ID:
[% customer_id %]
[% END %] [% IF has_requires %]
Requires:
[% requires %]
[% END %] [% IF has_restrictions %]
Restrictions:
[% restrictions %]
[% END %] [% IF has_todo %]
Todo:
[% todo %]
[% END %] [% IF has_uses %]
Uses:
[% uses %]
[% END %]
[% END %] [% IF n_visible_routines gt 1 %]

Routines

[% FOREACH r IN visible_routines %][% SCOPE r %]
[% IF is_function %]result = [% END %][% name %][% IF is_function %]([% END %][% IF n_visible_parameters gt 0 %][% FOREACH p IN visible_parameters %][% SCOPE p %][% IF is_optional %] [[% END %][% prefix %][% name %][% suffix %][% IF is_optional %]][% END %][% END %][% END %][% END %][% IF n_visible_keywords gt 0 %][% FOREACH k IN visible_keywords %][% SCOPE k %][% IF is_optional %] [[% END %][% prefix %][% IF is_boolean %]/[% END %][% name %][% IF ~is_boolean %]=[% IF type ne '' %][% type %][% ELSE %][% name %][% END %][% END %][% suffix %][% IF is_optional %]][% END %][% END %][% END %][% END %][% IF is_function %])[% END %]
[% comments_first_line %]
[% END %][% END %]
[% END %] [% IF n_visible_routines gt 0 %]
[% IF n_visible_routines gt 1 %]

Routine details

[% END %] [% FOREACH r IN visible_routines %][% SCOPE r %]
[% IF n_visible_routines gt 1 %]

[% name %]

[% END %] [% IF has_comments %]
[% comments %]
[% END %]

Syntax

[% IF is_function %]result = [% END %][% name %][% IF is_function %]([% END %][% IF n_visible_parameters gt 0 %][% FOREACH p IN visible_parameters %][% SCOPE p %][% IF is_optional %] [[% END %][% prefix %][% name %][% suffix %][% IF is_optional %]][% END %][% END %][% END %][% END %][% IF n_visible_keywords gt 0 %][% FOREACH k IN visible_keywords %][% SCOPE k %][% IF is_optional %] [[% END %][% prefix %][% IF is_boolean %]/[% END %][% name %][% IF ~is_boolean %]=[% IF type ne '' %][% type %][% ELSE %][% name %][% END %][% END %][% suffix %][% IF is_optional %]][% END %][% END %][% END %][% END %][% IF is_function %])[% END %]

[% IF is_function and has_returns %]

Return value

[% returns %]
[% END %] [% IF n_parameters gt 0 %]

Parameters

[% FOREACH p IN parameters %][% SCOPE p %]
[% name %] [% IF is_input %]in [% END %][% IF is_output %]out [% END %][% IF is_optional %]optional [% END %][% IF is_required %]required [% END %][% IF is_private %]private [% END %][% IF is_hidden %]hidden [% END %][% IF is_obsolete %]obsolete [% END %][% IF type ne '' %]type=[% type %] [% END %][% IF default_value ne '' %]default=[% default_value %][% END %]
[% comments %]
[% END %][% END %]
[% END %] [% IF n_keywords gt 0 %]

Keywords

[% FOREACH k IN keywords %][% SCOPE k %]
[% name %] [% IF is_input %]in [% END %][% IF is_output %]out [% END %][% IF is_optional %]optional [% END %][% IF is_required %]required [% END %][% IF is_private %]private [% END %][% IF is_hidden %]hidden [% END %][% IF is_obsolete %]obsolete [% END %][% IF type ne '' %]type=[% type %] [% END %][% IF default_value ne '' %]default=[% default_value %][% END %]
[% comments %]
[% END %][% END %]
[% END %] [% IF has_examples %]

Examples

[% examples %]
[% END %] [% IF has_author_info %]

Author information

[% IF has_author %]
Author:
[% author %]
[% END %] [% IF has_copyright %]
Copyright:
[% copyright %]
[% END %] [% IF has_history %]
History:
[% history %]
[% END %] [% IF has_version %]
Version:
[% version %]
[% END %]
[% END %] [% IF has_others %]

Other attributes

[% IF has_todo %]
Todo:
[% todo %]
[% END %] [% IF has_restrictions %]
Restrictions:
[% restrictions %]
[% END %] [% IF has_requires %]
Requires:
[% requires %]
[% END %] [% IF has_uses %]
Uses:
[% uses %]
[% END %] [% IF has_bugs %]
Bugs:
[% bugs %]
[% END %]
[% END %]
[% END %][% END %]
[% END %]