{% macro top_box(entry) %}
{% if entry.extends %}
Extends |
{% for e in entry.extends|sort -%}
{{ e|translink }}{% if not loop.last %}, {% endif %}
{% endfor %}
|
{% endif %}
{% if entry.implements %}
Implements
|
{% for e in entry.implements|sort -%}
{{ e|translink }}{% if not loop.last %}, {% endif %}
{% endfor %}
|
{% endif %}
{% if entry.all_extended %}
All Extended
|
{% for e in entry.all_extended|sort -%}
{{ e|translink }}{% if not loop.last %}, {% endif %}
{% endfor %}
|
{% endif %}
{% if entry.all_extending %}
All Subcl's
|
{% for e in entry.all_extending|sort -%}
{{ e|translink }}{% if not loop.last %}, {% endif %}
{% endfor %}
|
{% endif %}
{% if entry.all_implemented %}
All Impl'd
|
{% for e in entry.all_implemented|sort -%}
{{ e|translink }}{% if not loop.last %}, {% endif %}
{% endfor %}
|
{% endif %}
Defined in |
{% if entry.headerfiles %}
{% for h in entry.headerfiles|sort -%}
{{ h|e }}{% if not loop.last %}, {% endif %}
{% endfor %}
{% else %}
{% endif %}
|
Signature |
{%- for s in entry.signatures -%}
{{ s|transtext(False) }}
{% endfor -%}
|
{% endmacro %}
{% macro inheritance_concept(concept) -%}
{% if concept.extends %}
Extends |
{% for e in concept.extends|sort -%}
{{ e|translink }}{% if not loop.last %}, {% endif %}
{% endfor %}
|
{% endif %}
{% if concept.all_extended %}
All Extended Concepts |
{% for e in concept.all_extended|sort -%}
{{ e|translink }}{% if not loop.last %}, {% endif %}
{% endfor %}
|
{% endif %}
{% if concept.all_extending %}
All Known Refinements |
{% for e in concept.all_extending|sort -%}
{{ e|translink }}{% if not loop.last %}, {% endif %}
{% endfor %}
|
{% endif %}
{% if concept.all_implementing %}
All Implementing Classes |
{% for e in concept.all_implementing|sort -%}
{{ e|translink }}{% if not loop.last %}, {% endif %}
{% endfor %}
|
{% endif %}
{% endmacro %}
{% macro brief(entry) -%}
{{ entry.brief|transtext }}
{%- endmacro %}
{% macro body(entry, start_heading=3) -%}
{% if entry.body %}
{{ entry.body|transtext(class="body", start_heading=start_heading) }}
{% endif %}
{%- endmacro %}
{% macro see_also(entry, h_level=2) -%}
{% if entry.sees %}
{% for link in entry.sortedSees() %}
- {{ link|transtext(True) }}
{% endfor %}
{% endif %}
{%- endmacro %}
{% macro member_functions_ov(entry, doc, qualifier='Member') %}
{% if entry.hasSubEntry('member_function', doc) %}
{{ qualifier }} Function Overview
{% if entry.subentries['member_function'] -%}
{% endif %}
{% for cl in entry.all_extended|sort %}
{% if doc.top_level_entries[cl].subentries['member_function'] %}
{{ qualifier }} Functions Inherited From {{ cl|translink }}
{% for entry in doc.top_level_entries[cl].subentries['member_function']|sort(attribute='name') %}
{{ entry.name|translink(text=entry.local_name) }}
{% endfor %}
{% endif %}
{% endfor %}
{% if entry.kind == 'class' or entry.kind == 'specialization' %}
{% for co in entry.all_implemented|sort %}
{% if doc.top_level_entries[co].subentries['member_function'] %}
{{ qualifier }} Functions Inherited From {{ co|translink }}
{% for entry in doc.top_level_entries[co].subentries['member_function']|sort(attribute='name') %}
{{ entry.name|translink(text=entry.local_name) }}
{% endfor %}
{% endif %}
{% endfor %}
{% endif %}
{% endif %}
{% endmacro %}
{% macro member_typedefs_ov(entry, doc, qualifier='Member') %}
{% if entry.hasSubEntry('member_typedef', doc) %}
{{ qualifier }} Typedef Overview
{% if entry.subentries['member_typedef'] -%}
{% endif %}
{% for cl in entry.all_extended|sort %}
{% if doc.top_level_entries[cl].subentries['member_typedef'] %}
{{ qualifier }} Typedefs Inherited From {{ cl|translink }}
{% for entry in doc.top_level_entries[cl].subentries['member_typedef']|sort(attribute='name') %}
{{ entry.name|translink(text=entry.local_name) }}
{% endfor %}
{% endif %}
{% endfor %}
{% if entry.kind == 'class' or entry.kind == 'specialization' %}
{% for co in entry.all_implemented|sort %}
{% if doc.top_level_entries[co].subentries['member_typedef']|sort(attribute='name') %}
{{ qualifier }} Typedefs Inherited From {{ co|translink }}
{% for entry in doc.top_level_entries[co].subentries['member_typedef'] %}
{{ entry.name|translink(text=entry.local_name) }}
{% endfor %}
{% endif %}
{% endfor %}
{% endif %}
{% endif %} {#{% if entry.hasSubEntry('member_typedef', doc) %}#}
{% endmacro %}
{% macro interface_functions_ov(entry, doc, qualifier='Interface') %}
{% if entry.hasSubEntry('interface_function', doc) %}
{{ qualifier }} Function Overview
{% if entry.subentries['interface_function'] -%}
{% endif %}
{% for cl in entry.all_extended|sort %}
{% if doc.top_level_entries[cl].subentries['interface_function'] %}
{{ qualifier }} Functions Inherited From {{ cl|translink }}
{% for entry in doc.top_level_entries[cl].subentries['interface_function']|sort(attribute='name') %}
{{ entry.name|translink(text=entry.local_name) }}
{% endfor %}
{% endif %}
{% endfor %}
{% if entry.kind == 'class' or entry.kind == 'specialization' %}
{% for co in entry.all_implemented|sort %}
{% if doc.top_level_entries[co].subentries['interface_function']|sort(attribute='name') %}
{{ qualifier }} Functions Inherited From {{ co|translink }}
{% for entry in doc.top_level_entries[co].subentries['interface_function'] %}
{{ entry.name|translink(text=entry.local_name) }}
{% endfor %}
{% endif %}
{% endfor %}
{% endif %}
{% endif %} {#{% if entry.hasSubEntry('interface_function', doc) %}#}
{% endmacro %}
{% macro grouped_macros_ov(entry, doc, qualifier='Grouped') %}
{% if entry.subentries['grouped_macro'] -%}
{{ qualifier }} Macros Overview
{% for entry in entry.subentries['grouped_macro']|sort(attribute='name') %}
{% if entry.sig_entries %}
{{ sig_entries[0].toString() }}{{ entry.brief|transtext }} |
{% else %}
{{ entry.signatures[0].toHtmlLike(False) }} {{ entry.brief|transtext }} |
{% endif %}
{% endfor %}
{% endif %}
{% endmacro %}
{% macro grouped_tags_ov(entry, doc, qualifier='Interface') %}
{% if entry.subentries['grouped_tag'] -%}
{{ qualifier }} Tags Overview
{% endif %}
{% endmacro %}
{% macro interface_metafunctions_ov(entry, doc, qualifier='Interface') %}
{% if entry.hasSubEntry('interface_metafunction', doc) %}
{{ qualifier }} Metafunction Overview
{% if entry.subentries['interface_metafunction'] -%}
{% endif %}
{% for cl in entry.all_extended|sort %}
{% if doc.top_level_entries[cl].subentries['interface_metafunction'] %}
{{ qualifier }} Metafunctions Inherited From {{ cl|translink }}
{% for entry in doc.top_level_entries[cl].subentries['interface_metafunction']|sort(attribute='name') %}
{{ entry.name|translink(text=entry.local_name) }}
{% endfor %}
{% endif %}
{% endfor %}
{% if entry.kind == 'class' or entry.kind == 'specialization' %}
{% for co in entry.all_implemented|sort %}
{% if doc.top_level_entries[co].subentries['interface_metafunction'] %}
{{ qualifier }} Metafunctions Inherited From {{ co|translink }}
{% for entry in doc.top_level_entries[co].subentries['interface_metafunction']|sort(attribute='name') %}
{{ entry.name|translink(text=entry.local_name) }}
{% endfor %}
{% endif %}
{% endfor %}
{% endif %}
{% endif %} {#{% if entry.hasSubEntry('interface_metafunctions', doc) %}#}
{% endmacro %}
{% macro member_variables_ov(entry, doc, qualifier='Member') %}
{% if entry.hasSubEntry('member_variable', doc) %}
{{ qualifier }} Variable Overview
{% if entry.subentries['member_variable'] -%}
{% endif %}
{% for cl in entry.all_extended|sort %}
{% if doc.top_level_entries[cl].subentries['member_variable'] %}
{{ qualifier }} Variables Inherited From {{ cl|translink }}
{% for entry in doc.top_level_entries[cl].subentries['member_variable']|sort(attribute='name') %}
{{ entry.name|translink(text=entry.local_name) }}
{% endfor %}
{% endif %}
{% endfor %}
{% if entry.kind == 'class' or entry.kind == 'specialization' %}
{% for co in entry.all_implemented|sort %}
{% if doc.top_level_entries[co].subentries['member_variable'] %}
{{ qualifier }} Variable Inherited From {{ co|translink }}
{% for entry in doc.top_level_entries[co].subentries['member_variable']|sort(attribute='name') %}
{{ entry.name|translink(text=entry.local_name) }}
{% endfor %}
{% endif %}
{% endfor %}
{% endif %}
{% endif %} {#{% if entry.hasSubEntry('member_variables', doc) %}#}
{% endmacro %}
{% macro enum_values_ov(entry, doc) %}
{% if entry.hasSubEntry('enum_value', doc) %}
Enum Values Overview
{% if entry.subentries['enum_value'] -%}
{% endif %}
{% endif %} {#{% if entry.hasSubEntry('enum_value', doc) %}#}
{% endmacro %}
{% macro member_functions(entry, qualifier='Member') %}
{{ interface_functions(entry, 'Member', 'member_function') }}
{% endmacro %}
{% macro grouped_tags(entry, qualifier='Grouped') %}
{% if entry.subentries['grouped_tag'] -%}
{% endif %}
{% endmacro %}
{% macro grouped_macros(entry, doc, qualifier='Grouped') %}
{% if entry.subentries['grouped_macro'] -%}
{{ qualifier }} Macros Detail
{% for subentry in entry.subentries['grouped_macro']|sort(attribute='name') %}
{{ subentry.name|e }}
{% if subentry.headerfiles %}
- Defined in
-
{% for h in subentry.headerfiles|sort -%}
{{ h|e }}{% if not loop.last %}, {% endif %}
{% endfor %}
{% endif %}
{% if subentry.signatures -%}
{%- for s in subentry.signatures: -%}
{{ s|transtext(False) }}
{% endfor -%}
{%- endif %}
{{ subentry.brief|transtext }}
{% if subentry.params %}
- Parameters
{% for param in subentry.params %}
-
{{ param.name|e }}
{% if param.in_out %}
({{ {'IN': 'in', 'OUT': 'out', 'IN_OUT': 'in,out'}.get(param.in_out)|e }})
{% endif %} -
{{ param.desc|transtext(False) }}
{% endfor %}
{% endif %}
{% if subentry.tparams %}
- Template Parameters
{% for param in subentry.tparams %}
-
{{ param.type|e }}
-
{{ param.desc|transtext(False) }}
{% endfor %}
{% endif %}
{% if subentry.returns %}
- Return Values
{% for ret in subentry.returns %}
-
{{ ret.type|e }}
-
{{ ret.desc|transtext(False) }}
{% endfor %}
{% endif %}
{% if subentry.throws %}
- Thrown Exceptions
{% for thr in subentry.throws %}
-
{{ thr.type|e }}
-
{{ thr.desc|transtext(False) }}
{% endfor %}
{% endif %}
{% if subentry.dataraces %}
- Data Races
{% for datarace in subentry.dataraces %}
-
{{ datarace.desc|transtext(False) }}
{% endfor %}
{% else %}
- Data Races
-
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
{% endif %}
{% if subentry.sees %}
- See Also
-
{% for link in subentry.sortedSees() %}
- {{ link|transtext(True) }}
{% endfor %}
{% endif %}
{{ body(subentry, start_heading=4) }}
{% endfor %}
{% endif %}
{% endmacro %}
{% macro interface_functions(entry, qualifier='Interface', key='interface_function') %}
{% if entry.subentries[key] -%}
{{ qualifier }} Functions Detail
{% for subentry in entry.subentries[key]|sort(attribute='name') %}
{%- for s in subentry.signatures: -%}
{{ s|transtext(False) }}{% if not loop.last %}
{% endif -%}{%- endfor -%}
{% if subentry.headerfiles and qualifier == 'Grouped' %}
- Defined in
-
{% if subentry.headerfiles %}
{% for h in subentry.headerfiles|sort -%}
{{ h|e }}{% if not loop.last %}, {% endif %}
{% endfor %}
{% else %}
{% endif %}
{% endif %}
{% if subentry.deprecation_msgs %}
Deprecated.
{% for msg in subentry.deprecation_msgs %}
{{ msg|transtext(False) }}
{% endfor %}
{% endif %}
{% if subentry.warnings %}
Warning.
{% for msg in subentry.warnings %}
{{ msg|transtext(False) }}
{% endfor %}
{% endif %}
{% if subentry.notes %}
Note.
{% for msg in subentry.notes %}
{{ msg|transtext(False) }}
{% endfor %}
{% endif %}
{{ subentry.brief|transtext }}
{% if subentry.tparams %}
Template Parameters
{% for param in subentry.tparams %}
{{ param.type|e }} |
{{ param.desc|transtext(False) }} |
{% endfor %}
{% endif %}
{% if subentry.params %}
Parameters
{% for param in subentry.params %}
{% if param.in_out %}
{% if param.in_out == 'IN' %}
{{ param.name|e }}
{% elif param.in_out == 'OUT' %}
{{ param.name|e }}
{% elif param.in_out == 'IN_OUT' %}
{{ param.name|e }}
{% else %}
{{ param.name|e }}
{% endif %}
{% else %}
{{ param.name|e }}
{% endif %}
|
{{ param.desc|transtext(False) }} |
{% endfor %}
{% endif %}
{% if subentry.returns %}
Returns
{% for ret in subentry.returns %}
{{ ret.type|e }} |
{{ ret.desc|transtext(False) }} |
{% endfor %}
{% endif %}
{{ body(subentry, start_heading=4) }}
{% if subentry.throws %}
Thrown Exceptions
{% for thr in subentry.throws %}
{{ thr.type|e }} |
{{ thr.desc|transtext(False) }} |
{% endfor %}
{% endif %}
Data Races
{% if subentry.dataraces %}
{% for datarace in subentry.dataraces %}
{{ datarace.desc|transtext(False) }}
{% endfor %}
{% else %}
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
{% endif %}
{% if subentry.sees %}
See Also
{% for link in subentry.sortedSees() %}
- {{ link|transtext(True) }}
{% endfor %}
{% endif %}
{% endfor %}
{% endif %}
{% endmacro %}
{% macro member_typedefs(entry, qualifier='Member', key='member_typedef') %}
{% if entry.subentries[key] -%}
{{ qualifier }} Typedef Detail
{% for subentry in entry.subentries[key]|sort(attribute='name') %}
{%- for s in subentry.signatures: -%}
{{ s|transtext(False) }}{% if not loop.last %}
{% endif -%}{%- endfor -%}
{{ subentry.brief|transtext }}
{{ body(subentry, start_heading=4) }}
{% if subentry.sees %}
{% endif %}
{% endfor %}
{% endif %}
{% endmacro %}
{% macro interface_metafunctions(entry, qualifier='Interface') %}
{% if entry.subentries['interface_metafunction'] -%}
{% endif %}
{% endmacro %}
{% macro member_variables(entry, qualifier='Member') %}
{% if entry.subentries['member_variable'] -%}
{{ qualifier }} Variables Detail
{% for subentry in entry.subentries['member_variable']|sort(attribute='name') %}
{{ subentry.type|e }} {{ subentry.name|e }}
{{ subentry.brief|transtext }}
{{ body(subentry, start_heading=4) }}
{% endfor %}
{% endif %}
{% endmacro %}
{% macro enum_values(entry, qualifier='Member') %}
{% if entry.subentries['enum_value'] -%}
Enum Values
{% for subentry in entry.subentries['enum_value'] %}
{{ subentry.local_name|e }} |
{{ subentry.brief|transtext }}
{{ body(subentry, start_heading=3) }}
|
{% endfor %}
{% endif %}
{% endmacro %}
{% macro params(entry) %}
{% if entry.params %}
Parameters
{% for param in entry.params %}
{% if param.in_out %}
{% if param.in_out == 'IN' %}
{{ param.name|e }}
{% elif param.in_out == 'OUT' %}
{{ param.name|e }}
{% elif param.in_out == 'IN_OUT' %}
{{ param.name|e }}
{% else %}
{{ param.name|e }}
{% endif %}
{% else %}
{{ param.name|e }}
{% endif %}
|
{{ param.desc|transtext(False) }} |
{% endfor %}
{% endif %}
{% endmacro %}
{% macro tparams(entry) %}
{% if entry.tparams %}
Template Parameters
{% for param in entry.tparams %}
{{ param.type|e }} |
{{ param.desc|transtext(False) }} |
{% endfor %}
{% endif %}
{% endmacro %}
{% macro tparams_ov(entry) %}
{% if entry.tparams %}
{% if entry.tparams %}
Template Parameters
{% for param in entry.tparams %}
{{ param.type|e }} |
{{ param.desc|transtext(False) }} |
{% endfor %}
{% endif %}
{% endif %}
{% endmacro %}
{% macro return_values(entry) %}
{% if entry.returns %}
Return Values
{% for ret in entry.returns %}
{{ ret.type|e }} |
{{ ret.desc|transtext(False) }} |
{% endfor %}
{% endif %}
{% endmacro %}
{% macro throws(entry) %}
{% if entry.throws %}
Thrown Exceptions
{% for thr in entry.throws %}
{{ thr.type|e }} |
{{ thr.desc|transtext(False) }} |
{% endfor %}
{% endif %}
{% endmacro %}
{% macro dataraces(entry, h_level=2) -%}
{% if entry.dataraces %}
{% for draces in entry.dataraces %}
{{ draces.desc|transtext(False) }}
{% endfor %}
{% else %}
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
{% endif %}
{%- endmacro %}
{% macro dox_source(entry, in_comment=False) %}
{{ entry|to_dox(in_comment=in_comment)|e }}
{% endmacro %}