feat: Populate repo

This commit is contained in:
2023-03-29 14:02:05 +02:00
commit 28bec5ebb8
168 changed files with 17860 additions and 0 deletions

View File

@@ -0,0 +1,5 @@
@INCLUDE = doxy.conf
GENERATE_HTML = NO
GENERATE_XML = YES
XML_PROGRAMLISTING = YES
OUTPUT_DIRECTORY = ../../doc/doxygen

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,21 @@
{% set navbar_current = 'annotated' %}
{% extends 'base-index.html' %}
{% block main %}
<h1>Classes</h1>
<ul class="m-doc">
{% for i in index.symbols recursive %}
{% if i.children %}
<li class="m-doc-collapsible{% if loop.depth > CLASS_INDEX_EXPAND_LEVELS or (i.kind != 'namespace' and not CLASS_INDEX_EXPAND_INNER) %} collapsed{% endif %}">
<a href="#" onclick="return toggle(this)">{{ i.kind }}</a> <a href="{{ i.url }}" class="m-doc">{{ i.name }}</a>{% if i.is_inline %} <span class="m-label m-flat m-info">inline</span>{% endif %}{% if i.is_final %} <span class="m-label m-flat m-warning">final</span>{% endif %}{% if i.deprecated %} <span class="m-label m-danger">{{ i.deprecated }}</span>{% endif %}{% if i.since %} {{ i.since }}{% endif %} <span class="m-doc">{{ i.brief }}</span>
<ul class="m-doc">
{{ loop(i.children)|rtrim|indent(4, true) }}
</ul>
</li>
{% else %}
<li>{{ i.kind }} <a href="{{ i.url }}" class="m-doc">{{ i.name }}</a>{% if i.is_inline %} <span class="m-label m-flat m-info">inline</span>{% endif %}{% if i.is_final %} <span class="m-label m-flat m-warning">final</span>{% endif %}{% if i.deprecated %} <span class="m-label m-danger">{{ i.deprecated }}</span>{% endif %}{% if i.since %} {{ i.since }}{% endif %} <span class="m-doc">{{ i.brief }}</span></li>
{% endif %}
{% endfor %}
</ul>
{{ super() -}}
{% endblock %}

View File

@@ -0,0 +1,559 @@
{% extends 'base.html' %}
{% macro entry_class(class) %}{% include 'entry-class.html' %}{% endmacro %}
{% macro entry_typedef(typedef, mark_nonpublic=False) %}{% include 'entry-typedef.html' %}{% endmacro %}
{% macro entry_enum(enum, mark_nonpublic=False) %}{% include 'entry-enum.html' %}{% endmacro %}
{% macro entry_func(func, mark_nonpublic=False) %}{% include 'entry-func.html' %}{% endmacro %}
{% macro entry_var(var, mark_nonpublic=False) %}{% include 'entry-var.html' %}{% endmacro %}
{% macro entry_define(define) %}{% include 'entry-define.html' %}{% endmacro %}
{% macro details_typedef(typedef, prefix) %}{% include 'details-typedef.html' %}{% endmacro %}
{% macro details_enum(enum, prefix) %}{% include 'details-enum.html' %}{% endmacro %}
{% macro details_func(func, prefix) %}{% include 'details-func.html' %}{% endmacro %}
{% macro details_var(var, prefix) %}{% include 'details-var.html' %}{% endmacro %}
{% macro details_define(define) %}{% include 'details-define.html' %}{% endmacro %}
{% block title %}{% set j = joiner('::') %}{% for name, _ in compound.breadcrumb %}{{ j() }}{{ name }}{% endfor %} {{ compound.kind }} | {{ super() }}{% endblock %}
{% block main %}
<h1>
{% if compound.templates != None %}
{% if compound.include %}
<div class="m-doc-include m-code m-inverted m-right-m m-text-right"><span class="cp">#include</span> <a class="cpf" href="{{ compound.include[1] }}">{{ compound.include[0] }}</a></div>
{% endif %}
{% set j = joiner(', ') %}
<div class="m-doc-template">template&lt;{% for t in compound.templates %}{{ j() }}{{ t.type }}{% if t.name %} {{ t.name }}{% endif %}{% if t.default %} = {{ t.default }}{% endif%}{% endfor %}&gt;</div>
{% endif %}
{%+ for name, target in compound.breadcrumb[:-1] %}<span class="m-breadcrumb"><a href="{{ target }}">{{ name }}</a>::<wbr/></span>{% endfor %}{{ compound.breadcrumb[-1][0] }} <span class="m-thin">{{ compound.kind }}</span>{% if compound.is_final %} <span class="m-label m-flat m-warning">final</span>{% endif %}{% if compound.since %} {{ compound.since }}{% endif %}
{# need an explicit space here otherwise the newline gets removed #}
{% if compound.include and compound.templates == None %}
<div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="{{ compound.include[1] }}">{{ compound.include[0] }}</a></div>
{% endif %}
</h1>
{% if compound.brief %}
<p>{{ compound.brief }}</p>
{% endif %}
{% if compound.has_template_details %}
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Template parameters</th></tr>
</thead>
<tbody>
{% for template in compound.templates|selectattr('name') %}
<tr>
<td{% if loop.index == 1 %} style="width: 1%"{% endif %}>{{ template.name }}</td>
<td>{{ template.description }}</td>
</tr>
{% endfor %}
</tbody>
</table>
{% endif %}
{% if compound.sections or compound.public_types or compound.public_static_funcs or compound.typeless_funcs or compound.public_funcs or compound.signals or compound.public_slots or compound.public_static_vars or compound.public_vars or compound.protected_types or compound.protected_static_funcs or compound.protected_funcs or compound.protected_signals or compound.protected_static_vars or compound.protected_vars or compound.private_funcs or compound.private_slots or compound.groups or compound.friend_funcs or compound.related %}
<div class="m-block m-default">
<h3>Contents</h3>
<ul>
{% for id, name, children in compound.sections recursive %}
{% if children %}
<li>
<a href="#{{ id }}">{{ name }}</a>
<ul>
{{ loop(children)|rtrim|indent(4, true) }}
</ul>
</li>
{% else %}
<li><a href="#{{ id }}">{{ name }}</a></li>
{% endif %}
{% endfor %}
<li>
Reference
<ul>
{% if compound.base_classes %}
<li><a href="#base-classes">Base classes</a></li>
{% endif %}
{% if compound.derived_classes %}
<li><a href="#derived-classes">Derived classes</a></li>
{% endif %}
{% if compound.public_types %}
<li><a href="#pub-types">Public types</a></li>
{% endif %}
{% if compound.public_static_vars %}
<li><a href="#pub-static-attribs">Public static variables</a></li>
{% endif %}
{% if compound.public_static_funcs %}
<li><a href="#pub-static-methods">Public static functions</a></li>
{% endif %}
{% if compound.typeless_funcs %}
<li><a href="#typeless-methods">Constructors, destructors, conversion operators</a></li>
{% endif %}
{% if compound.public_funcs %}
<li><a href="#pub-methods">Public functions</a></li>
{% endif %}
{% if compound.signals %}
<li><a href="#signals">Signals</a></li>
{% endif %}
{% if compound.public_slots %}
<li><a href="#pub-slots">Public slots</a></li>
{% endif %}
{% if compound.public_vars %}
<li><a href="#pub-attribs">Public variables</a></li>
{% endif %}
{% if compound.protected_types %}
<li><a href="#pro-types">Protected types</a></li>
{% endif %}
{% if compound.protected_static_funcs %}
<li><a href="#pro-static-methods">Protected static functions</a></li>
{% endif %}
{% if compound.protected_funcs %}
<li><a href="#pro-methods">Protected functions</a></li>
{% endif %}
{% if compound.protected_slots %}
<li><a href="#pro-slots">Protected slots</a></li>
{% endif %}
{% if compound.protected_static_vars %}
<li><a href="#pro-static-attribs">Protected static variables</a></li>
{% endif %}
{% if compound.protected_vars %}
<li><a href="#pro-attribs">Protected variables</a></li>
{% endif %}
{% if compound.private_funcs %}
<li><a href="#pri-methods">Private functions</a></li>
{% endif %}
{% if compound.private_slots %}
<li><a href="#pri-slots">Private slots</a></li>
{% endif %}
{% for group in compound.groups %}
<li><a href="#{{ group.id }}">{{ group.name }}</a></li>
{% endfor %}
{% if compound.friend_funcs %}
<li><a href="#friends">Friends</a></li>
{% endif %}
{% if compound.related %}
<li><a href="#related">Related</a></li>
{% endif %}
</ul>
</li>
</ul>
</div>
{% endif %}
{% if compound.description %}
{{ compound.description }}
{% endif %}
{% if compound.base_classes %}
<section id="base-classes">
<h2><a href="#base-classes">Base classes</a></h2>
<dl class="m-doc">
{% for class in compound.base_classes %}
{{ entry_class(class) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% if compound.derived_classes %}
<section id="derived-classes">
<h2><a href="#derived-classes">Derived classes</a></h2>
<dl class="m-doc">
{% for class in compound.derived_classes %}
{{ entry_class(class) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% if compound.public_types %}
<section id="pub-types">
<h2><a href="#pub-types">Public types</a></h2>
<dl class="m-doc">
{% for kind, type in compound.public_types %}
{% if kind == 'class' %}
{{ entry_class(type) }}
{% elif kind == 'enum' %}
{{ entry_enum(type) }}
{% elif kind == 'typedef' %}
{{ entry_typedef(type) }}
{% endif %}
{% endfor %}
</dl>
</section>
{% endif %}
{% if compound.public_static_vars %}
<section id="pub-static-attribs">
<h2><a href="#pub-static-attribs">Public static variables</a></h2>
<dl class="m-doc">
{% for var in compound.public_static_vars %}
{{ entry_var(var) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% if compound.public_static_funcs %}
<section id="pub-static-methods">
<h2><a href="#pub-static-methods">Public static functions</a></h2>
<dl class="m-doc">
{% for func in compound.public_static_funcs %}
{{ entry_func(func) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% if compound.typeless_funcs %}
<section id="typeless-methods">
<h2><a href="#typeless-methods">Constructors, destructors, conversion operators</a></h2>
<dl class="m-doc">
{% for func in compound.typeless_funcs %}
{{ entry_func(func) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% if compound.public_funcs %}
<section id="pub-methods">
<h2><a href="#pub-methods">Public functions</a></h2>
<dl class="m-doc">
{% for func in compound.public_funcs %}
{{ entry_func(func) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% if compound.signals %}
<section id="signals">
<h2><a href="#signals">Signals</a></h2>
<dl class="m-doc">
{% for func in compound.signals %}
{{ entry_func(func) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% if compound.public_slots %}
<section id="pub-slots">
<h2><a href="#pub-slots">Public slots</a></h2>
<dl class="m-doc">
{% for func in compound.public_slots %}
{{ entry_func(func) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% if compound.public_vars %}
<section id="pub-attribs">
<h2><a href="#pub-attribs">Public variables</a></h2>
<dl class="m-doc">
{% for var in compound.public_vars %}
{{ entry_var(var) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% if compound.protected_types %}
<section id="pro-types">
<h2><a href="#pro-types">Protected types</a></h2>
<dl class="m-doc">
{% for kind, type in compound.protected_types %}
{% if kind == 'class' %}
{{ entry_class(type) }}
{% elif kind == 'enum' %}
{{ entry_enum(type) }}
{% elif kind == 'typedef' %}
{{ entry_typedef(type) }}
{% endif %}
{% endfor %}
</dl>
</section>
{% endif %}
{% if compound.protected_static_funcs %}
<section id="pro-static-methods">
<h2><a href="#pro-static-methods">Protected static functions</a></h2>
<dl class="m-doc">
{% for func in compound.protected_static_funcs %}
{{ entry_func(func) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% if compound.protected_funcs %}
<section id="pro-methods">
<h2><a href="#pro-methods">Protected functions</a></h2>
<dl class="m-doc">
{% for func in compound.protected_funcs %}
{{ entry_func(func) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% if compound.protected_slots %}
<section id="pro-slots">
<h2><a href="#pro-slots">Protected slots</a></h2>
<dl class="m-doc">
{% for func in compound.protected_slots %}
{{ entry_func(func) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% if compound.protected_static_vars %}
<section id="pro-static-attribs">
<h2><a href="#pro-static-attribs">Protected static variables</a></h2>
<dl class="m-doc">
{% for var in compound.protected_static_vars %}
{{ entry_var(var) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% if compound.protected_vars %}
<section id="pro-attribs">
<h2><a href="#pro-attribs">Protected variables</a></h2>
<dl class="m-doc">
{% for var in compound.protected_vars %}
{{ entry_var(var) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% if compound.private_funcs %}
<section id="pri-methods">
<h2><a href="#pri-methods">Private functions</a></h2>
<dl class="m-doc">
{% for func in compound.private_funcs %}
{{ entry_func(func) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% if compound.private_slots %}
<section id="pri-slots">
<h2><a href="#pri-slots">Private slots</a></h2>
<dl class="m-doc">
{% for func in compound.private_slots %}
{{ entry_func(func) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% for group in compound.groups %}
<section id="{{ group.id }}">
<h2><a href="#{{ group.id }}">{{ group.name }}</a></h2>
{% if group.description %}
{{ group.description }}
{% endif %}
<dl class="m-doc">
{% for kind, member in group.members %}
{% if kind == 'typedef' %}
{{ entry_typedef(member, mark_nonpublic=True) }}
{% elif kind == 'enum' %}
{{ entry_enum(member, mark_nonpublic=True) }}
{% elif kind == 'func' %}
{{ entry_func(member, mark_nonpublic=True) }}
{% elif kind == 'var' %}
{{ entry_var(member, mark_nonpublic=True) }}
{% endif %}
{% endfor %}
</dl>
</section>
{% endfor %}
{% if compound.friend_funcs %}
<section id="friends">
<h2><a href="#friends">Friends</a></h2>
<dl class="m-doc">
{% for func in compound.friend_funcs %}
{{ entry_func(func) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% if compound.related %}
<section id="related">
<h2><a href="#related">Related</a></h2>
<dl class="m-doc">
{% for kind, member in compound.related %}
{% if kind == 'typedef' %}
{{ entry_typedef(member) }}
{% elif kind == 'enum' %}
{{ entry_enum(member) }}
{% elif kind == 'func' %}
{{ entry_func(member) }}
{% elif kind == 'var' %}
{{ entry_var(member) }}
{% elif kind == 'define' %}
{{ entry_define(member) }}
{% endif %}
{% endfor %}
</dl>
</section>
{% endif %}
{% if compound.has_enum_details %}
<section>
<h2>Enum documentation</h2>
{% for kind, member in compound.public_types %}
{% if kind == 'enum' and member.has_details %}
{{ details_enum(member, compound.prefix_wbr) }}
{% endif %}
{% endfor %}
{% for kind, member in compound.protected_types %}
{% if kind == 'enum' and member.has_details %}
{{ details_enum(member, compound.prefix_wbr) }}
{% endif %}
{% endfor %}
{% for group in compound.groups %}
{% for kind, member in group.members %}
{% if kind == 'enum' and member.has_details %}
{{ details_enum(member, compound.prefix_wbr) }}
{% endif %}
{% endfor %}
{% endfor %}
{% for kind, member in compound.related %}
{% if kind == 'enum' and member.has_details %}
{{ details_enum(member, '') }}
{% endif %}
{% endfor %}
</section>
{% endif %}
{% if compound.has_typedef_details %}
<section>
<h2>Typedef documentation</h2>
{% for kind, member in compound.public_types %}
{% if kind == 'typedef' and member.has_details %}
{{ details_typedef(member, compound.prefix_wbr) }}
{% endif %}
{% endfor %}
{% for kind, member in compound.protected_types %}
{% if kind == 'typedef' and member.has_details %}
{{ details_typedef(member, compound.prefix_wbr) }}
{% endif %}
{% endfor %}
{% for group in compound.groups %}
{% for kind, member in group.members %}
{% if kind == 'typedef' and member.has_details %}
{{ details_typedef(member, compound.prefix_wbr) }}
{% endif %}
{% endfor %}
{% endfor %}
{% for kind, member in compound.related %}
{% if kind == 'typedef' and member.has_details %}
{{ details_typedef(member, '') }}
{% endif %}
{% endfor %}
</section>
{% endif %}
{% if compound.has_func_details %}
<section>
<h2>Function documentation</h2>
{% for func in compound.public_static_funcs %}
{% if func.has_details %}
{{ details_func(func, compound.prefix_wbr) }}
{% endif %}
{% endfor %}
{% for func in compound.typeless_funcs %}
{% if func.has_details %}
{{ details_func(func, compound.prefix_wbr) }}
{% endif %}
{% endfor %}
{% for func in compound.public_funcs %}
{% if func.has_details %}
{{ details_func(func, compound.prefix_wbr) }}
{% endif %}
{% endfor %}
{% for func in compound.signals %}
{% if func.has_details %}
{{ details_func(func, compound.prefix_wbr) }}
{% endif %}
{% endfor %}
{% for func in compound.public_slots %}
{% if func.has_details %}
{{ details_func(func, compound.prefix_wbr) }}
{% endif %}
{% endfor %}
{% for func in compound.protected_static_funcs %}
{% if func.has_details %}
{{ details_func(func, compound.prefix_wbr) }}
{% endif %}
{% endfor %}
{% for func in compound.protected_funcs %}
{% if func.has_details %}
{{ details_func(func, compound.prefix_wbr) }}
{% endif %}
{% endfor %}
{% for func in compound.protected_slots %}
{% if func.has_details %}
{{ details_func(func, compound.prefix_wbr) }}
{% endif %}
{% endfor %}
{% for func in compound.private_funcs %}
{% if func.has_details %}
{{ details_func(func, compound.prefix_wbr) }}
{% endif %}
{% endfor %}
{% for func in compound.private_slots %}
{% if func.has_details %}
{{ details_func(func, compound.prefix_wbr) }}
{% endif %}
{% endfor %}
{% for group in compound.groups %}
{% for kind, member in group.members %}
{% if kind == 'func' and member.has_details %}
{{ details_func(member, compound.prefix_wbr) }}
{% endif %}
{% endfor %}
{% endfor %}
{% for func in compound.friend_funcs %}
{% if func.has_details %}
{{ details_func(func, '') }}
{% endif %}
{% endfor %}
{% for kind, member in compound.related %}
{% if kind == 'func' and member.has_details %}
{{ details_func(member, '') }}
{% endif %}
{% endfor %}
</section>
{% endif %}
{% if compound.has_var_details %}
<section>
<h2>Variable documentation</h2>
{% for var in compound.public_static_vars %}
{% if var.has_details %}
{{ details_var(var, compound.prefix_wbr) }}
{% endif %}
{% endfor %}
{% for var in compound.public_vars %}
{% if var.has_details %}
{{ details_var(var, compound.prefix_wbr) }}
{% endif %}
{% endfor %}
{% for var in compound.protected_static_vars %}
{% if var.has_details %}
{{ details_var(var, compound.prefix_wbr) }}
{% endif %}
{% endfor %}
{% for var in compound.protected_vars %}
{% if var.has_details %}
{{ details_var(var, compound.prefix_wbr) }}
{% endif %}
{% endfor %}
{% for group in compound.groups %}
{% for kind, member in group.members %}
{% if kind == 'var' and member.has_details %}
{{ details_var(member, compound.prefix_wbr) }}
{% endif %}
{% endfor %}
{% endfor %}
{% for kind, member in compound.related %}
{% if kind == 'var' and member.has_details %}
{{ details_var(member, '') }}
{% endif %}
{% endfor %}
</section>
{% endif %}
{% if compound.has_define_details %}
<section>
<h2>Define documentation</h2>
{% for kind, member in compound.related %}
{% if kind == 'define' and member.has_details %}
{{ details_define(member) }}
{% endif %}
{% endfor %}
</section>
{% endif %}
{% endblock %}

View File

@@ -0,0 +1,20 @@
{% extends 'base.html' %}
{% block main %}
<script>
function toggle(e) {
e.parentElement.className = e.parentElement.className == 'm-doc-collapsible' ?
'm-doc-expansible' : 'm-doc-collapsible';
return false;
}
/* Collapse all nodes marked as such. Doing it via JS instead of
directly in markup so disabling it doesn't harm usability. The list
is somehow regenerated on every iteration and shrinks as I change
the classes. It's not documented anywhere and I'm not sure if this
is the same across browsers, so I am going backwards in that list to
be sure. */
var collapsed = document.getElementsByClassName("collapsed");
for(var i = collapsed.length - 1; i >= 0; --i)
collapsed[i].className = 'm-doc-expansible';
</script>
{% endblock %}

View File

@@ -0,0 +1,302 @@
{% extends 'base.html' %}
{% set prefix = compound.prefix_wbr %}
{% macro entry_module(module) %}{% include 'entry-module.html' %}{% endmacro %}
{% macro entry_dir(dir) %}{% include 'entry-dir.html' %}{% endmacro %}
{% macro entry_file(file) %}{% include 'entry-file.html' %}{% endmacro %}
{% macro entry_namespace(namespace) %}{% include 'entry-namespace.html' %}{% endmacro %}
{% macro entry_class(class) %}{% include 'entry-class.html' %}{% endmacro %}
{% macro entry_enum(enum) %}{% include 'entry-enum.html' %}{% endmacro %}
{% macro entry_typedef(typedef) %}{% include 'entry-typedef.html' %}{% endmacro %}
{% macro entry_func(func) %}{% include 'entry-func.html' %}{% endmacro %}
{% macro entry_var(var) %}{% include 'entry-var.html' %}{% endmacro %}
{% macro entry_define(define) %}{% include 'entry-define.html' %}{% endmacro %}
{% macro details_enum(enum) %}{% include 'details-enum.html' %}{% endmacro %}
{% macro details_typedef(typedef) %}{% include 'details-typedef.html' %}{% endmacro %}
{% macro details_func(func) %}{% include 'details-func.html' %}{% endmacro %}
{% macro details_var(var) %}{% include 'details-var.html' %}{% endmacro %}
{% macro details_define(define) %}{% include 'details-define.html' %}{% endmacro %}
{% block main %}
{% block header %}
{% endblock %}
{% if compound.brief %}
<p>{{ compound.brief }}</p>
{% endif %}
{% if compound.sections or compound.modules or compound.dirs or compound.files or compound.namespaces or compound.classes or compound.typedefs or compound.funcs or compound.vars or compound.defines or compound.groups %}
<div class="m-block m-default">
<h3>Contents</h3>
<ul>
{% for id, name, children in compound.sections recursive %}
{% if children %}
<li>
<a href="#{{ id }}">{{ name }}</a>
<ul>
{{ loop(children)|rtrim|indent(4, true) }}
</ul>
</li>
{% else %}
<li><a href="#{{ id }}">{{ name }}</a></li>
{% endif %}
{% endfor %}
{% if compound.modules or compound.dirs or compound.files or compound.namespaces or compound.classes or compound.typedefs or compound.funcs or compound.vars or compound.defines or compound.groups %}
<li>
Reference
<ul>
{% if compound.modules %}
<li><a href="#groups">Modules</a></li>
{% endif %}
{% if compound.dirs %}
<li><a href="#subdirs">Directories</a></li>
{% endif %}
{% if compound.files %}
<li><a href="#files">Files</a></li>
{% endif %}
{% if compound.namespaces %}
<li><a href="#namespaces">Namespaces</a></li>
{% endif %}
{% if compound.classes %}
<li><a href="#nested-classes">Classes</a></li>
{% endif %}
{% if compound.enums %}
<li><a href="#enum-members">Enums</a></li>
{% endif %}
{% if compound.typedefs %}
<li><a href="#typedef-members">Typedefs</a></li>
{% endif %}
{% if compound.funcs %}
<li><a href="#func-members">Functions</a></li>
{% endif %}
{% if compound.vars %}
<li><a href="#var-members">Variables</a></li>
{% endif %}
{% if compound.defines %}
<li><a href="#define-members">Defines</a></li>
{% endif %}
{% for group in compound.groups %}
<li><a href="#{{ group.id }}">{{ group.name }}</a></li>
{% endfor %}
</ul>
</li>
{% endif %}
</ul>
</div>
{% endif %}
{% if compound.description %}
{{ compound.description }}
{% endif %}
{% if compound.modules %}
<section id="groups">
<h2><a href="#groups">Modules</a></h2>
<dl class="m-doc">
{% for module in compound.modules %}
{{ entry_module(module) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% if compound.dirs %}
<section id="subdirs">
<h2><a href="#subdirs">Directories</a></h2>
<dl class="m-doc">
{% for dir in compound.dirs %}
{{ entry_dir(dir) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% if compound.files %}
<section id="files">
<h2><a href="#files">Files</a></h2>
<dl class="m-doc">
{% for file in compound.files %}
{{ entry_file(file) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% if compound.namespaces %}
<section id="namespaces">
<h2><a href="#namespaces">Namespaces</a></h2>
<dl class="m-doc">
{% for namespace in compound.namespaces %}
{{ entry_namespace(namespace) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% if compound.classes %}
<section id="nested-classes">
<h2><a href="#nested-classes">Classes</a></h2>
<dl class="m-doc">
{% for class in compound.classes %}
{{ entry_class(class) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% if compound.enums %}
<section id="enum-members">
<h2><a href="#enum-members">Enums</a></h2>
<dl class="m-doc">
{% for enum in compound.enums %}
{{ entry_enum(enum) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% if compound.typedefs %}
<section id="typedef-members">
<h2><a href="#typedef-members">Typedefs</a></h2>
<dl class="m-doc">
{% for typedef in compound.typedefs %}
{{ entry_typedef(typedef) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% if compound.funcs %}
<section id="func-members">
<h2><a href="#func-members">Functions</a></h2>
<dl class="m-doc">
{% for func in compound.funcs %}
{{ entry_func(func) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% if compound.vars %}
<section id="var-members">
<h2><a href="#var-members">Variables</a></h2>
<dl class="m-doc">
{% for var in compound.vars %}
{{ entry_var(var) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% if compound.defines %}
<section id="define-members">
<h2><a href="#define-members">Defines</a></h2>
<dl class="m-doc">
{% for define in compound.defines %}
{{ entry_define(define) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% for group in compound.groups %}
<section id="{{ group.id }}">
<h2><a href="#{{ group.id }}">{{ group.name }}</a></h2>
{% if group.description %}
{{ group.description }}
{% endif %}
<dl class="m-doc">
{% for kind, member in group.members %}
{% if kind == 'namespace' %}
{{ entry_namespace(member) }}
{% elif kind == 'class' %}
{{ entry_class(member) }}
{% elif kind == 'enum' %}
{{ entry_enum(member) }}
{% elif kind == 'typedef' %}
{{ entry_typedef(member) }}
{% elif kind == 'func' %}
{{ entry_func(member) }}
{% elif kind == 'var' %}
{{ entry_var(member) }}
{% elif kind == 'define' %}
{{ entry_define(member) }}
{% endif %}
{% endfor %}
</dl>
</section>
{% endfor %}
{% if compound.has_enum_details %}
<section>
<h2>Enum documentation</h2>
{% for enum in compound.enums %}
{% if enum.has_details %}
{{ details_enum(enum) }}
{% endif %}
{% endfor %}
{% for group in compound.groups %}
{% for kind, member in group.members %}
{% if kind == 'enum' and member.has_details %}
{{ details_enum(member) }}
{% endif %}
{% endfor %}
{% endfor %}
</section>
{% endif %}
{% if compound.has_typedef_details %}
<section>
<h2>Typedef documentation</h2>
{% for typedef in compound.typedefs %}
{% if typedef.has_details %}
{{ details_typedef(typedef) }}
{% endif %}
{% endfor %}
{% for group in compound.groups %}
{% for kind, member in group.members %}
{% if kind == 'typedef' and member.has_details %}
{{ details_typedef(member) }}
{% endif %}
{% endfor %}
{% endfor %}
</section>
{% endif %}
{% if compound.has_func_details %}
<section>
<h2>Function documentation</h2>
{% for func in compound.funcs %}
{% if func.has_details %}
{{ details_func(func) }}
{% endif %}
{% endfor %}
{% for group in compound.groups %}
{% for kind, member in group.members %}
{% if kind == 'func' and member.has_details %}
{{ details_func(member) }}
{% endif %}
{% endfor %}
{% endfor %}
</section>
{% endif %}
{% if compound.has_var_details %}
<section>
<h2>Variable documentation</h2>
{% for var in compound.vars %}
{% if var.has_details %}
{{ details_var(var) }}
{% endif %}
{% endfor %}
{% for group in compound.groups %}
{% for kind, member in group.members %}
{% if kind == 'var' and member.has_details %}
{{ details_var(member) }}
{% endif %}
{% endfor %}
{% endfor %}
</section>
{% endif %}
{% if compound.has_define_details %}
<section>
<h2>Define documentation</h2>
{% for define in compound.defines %}
{% if define.has_details %}
{{ details_define(define) }}
{% endif %}
{% endfor %}
{% for group in compound.groups %}
{% for kind, member in group.members %}
{% if kind == 'define' and member.has_details %}
{{ details_define(member) }}
{% endif %}
{% endfor %}
{% endfor %}
</section>
{% endif %}
{% endblock %}

View File

@@ -0,0 +1,175 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>{% block title %}{{ PROJECT_NAME }}{% if PROJECT_BRIEF %} {{ PROJECT_BRIEF }}{% endif %}{% endblock %}</title>
{% for css in STYLESHEETS %}
<link rel="stylesheet" href="{{ css|basename_or_url|e }}" />
{% endfor %}
{% if FAVICON %}
<link rel="icon" href="{{ FAVICON[0]|basename_or_url|e }}" type="{{ FAVICON[1] }}" />
{% endif %}
{% if not SEARCH_DISABLED and SEARCH_BASE_URL %}
<link rel="search" type="application/opensearchdescription+xml" href="opensearch.xml" title="Search {{ PROJECT_NAME }} documentation" />
{% endif %}
{% block header_links %}
{% endblock %}
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
{% if THEME_COLOR %}
<meta name="theme-color" content="{{ THEME_COLOR }}" />
{% endif %}
{% if HTML_HEADER %}
{{ HTML_HEADER|rtrim|indent(2) }}
{% endif %}
<style>
li {margin-top: 10px;}
</style>
</head>
<body>
<header><nav id="navigation">
<div class="m-container">
<div class="m-row">
{% if MAIN_PROJECT_URL and PROJECT_BRIEF %}
<span id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">
<a href="{{ MAIN_PROJECT_URL }}">{% if PROJECT_LOGO %}<img src="{{ PROJECT_LOGO|basename_or_url|e }}" alt="" />{% endif %}{{ PROJECT_NAME }}</a> <span class="m-breadcrumb">|</span> <a href="index.html" class="m-thin">{{ PROJECT_BRIEF }}</a>
</span>
{% else %}
<a href="index.html" id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">{% if PROJECT_LOGO %}<img src="{{ PROJECT_LOGO|basename_or_url|e }}" alt="" />{% endif %}{{ PROJECT_NAME }}{% if PROJECT_BRIEF %} <span class="m-thin">{{ PROJECT_BRIEF }}</span>{% endif %}</a>
{% endif %}
{% if LINKS_NAVBAR1 or LINKS_NAVBAR2 or not SEARCH_DISABLED %}
<div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
{% if not SEARCH_DISABLED %}
<a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
</svg></a>
{% endif %}
<a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
<a id="m-navbar-hide" href="#" title="Hide navigation"></a>
</div>
<div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
<div class="m-row">
<ol class="{% if LINKS_NAVBAR2 %}m-col-t-6{% else %}m-col-t-12{% endif %} m-col-m-none">
{% for html, title, link, id, sub in LINKS_NAVBAR1 %}
{% if not sub %}
<li>{% if html %}{{ html }}{% else %}<a href="{{ link }}"{% if (compound and compound.id == id) or navbar_current == id %} id="m-navbar-current"{% endif %}>{{ title }}</a>{% endif %}</li>
{% else %}
<li>
{% if html %}
{{ html }}
{% else %}
<a href="{{ link }}"{% if (compound and compound.id == id) or navbar_current == id %} id="m-navbar-current"{% endif %}>{{ title }}</a>
{% endif %}
<ol>
{% for html, title, link, id in sub %}
<li>{% if html %}{{ html }}{% else %}<a href="{{ link }}"{% if (compound and compound.id == id) or navbar_current == id %} id="m-navbar-current"{% endif %}>{{ title }}</a>{% endif %}</li>
{% endfor %}
</ol>
</li>
{% endif %}
{% endfor %}
</ol>
{% if LINKS_NAVBAR2 or not SEARCH_DISABLED %}
{% set start = LINKS_NAVBAR1|length + 1 %}
<ol class="m-col-t-6 m-col-m-none" start="{{ start }}">
{% for html, title, link, id, sub in LINKS_NAVBAR2 %}
{% if not sub %}
<li>{% if html %}{{ html }}{% else %}<a href="{{ link }}"{% if (compound and compound.id == id) or navbar_current == id %} id="m-navbar-current"{% endif %}>{{ title }}</a>{% endif %}</li>
{% else %}
<li>
{% if html %}
{{ html }}
{% else %}
<a href="{{ link }}"{% if (compound and compound.id == id) or navbar_current == id %} id="m-navbar-current"{% endif %}>{{ title }}</a>
{% endif %}
<ol>
{% for html, title, link, id in sub %}
<li>{% if html %}{{ html }}{% else %}<a href="{{ link }}"{% if (compound and compound.id == id) or navbar_current == id %} id="m-navbar-current"{% endif %}>{{ title }}</a>{% endif %}</li>
{% endfor %}
</ol>
</li>
{% endif %}
{% endfor %}
{% if not SEARCH_DISABLED %}
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<use href="#m-doc-search-icon-path" />
</svg></a></li>
{% endif %}
<li class="m-show-m"><a target="_blank" href="https://github.com/Theldus/wsServer" class="m-doc-search-icon" title="GitHub Page">
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M12 0c-6.626 0-12 5.373-12 12 0 5.302 3.438 9.8 8.207 11.387.599.111.793-.261.793-.577v-2.234c-3.338.726-4.033-1.416-4.033-1.416-.546-1.387-1.333-1.756-1.333-1.756-1.089-.745.083-.729.083-.729 1.205.084 1.839 1.237 1.839 1.237 1.07 1.834 2.807 1.304 3.492.997.107-.775.418-1.305.762-1.604-2.665-.305-5.467-1.334-5.467-5.931 0-1.311.469-2.381 1.236-3.221-.124-.303-.535-1.524.117-3.176 0 0 1.008-.322 3.301 1.23.957-.266 1.983-.399 3.003-.404 1.02.005 2.047.138 3.006.404 2.291-1.552 3.297-1.23 3.297-1.23.653 1.653.242 2.874.118 3.176.77.84 1.235 1.911 1.235 3.221 0 4.609-2.807 5.624-5.479 5.921.43.372.823 1.102.823 2.222v3.293c0 .319.192.694.801.576 4.765-1.589 8.199-6.086 8.199-11.386 0-6.627-5.373-12-12-12z"/></svg>
</a></li>
</ol>
{% endif %}
</div>
</div>
{% endif %}
</div>
</div>
</nav></header>
<main><article>
<div class="m-container m-container-inflatable">
<div class="m-row">
<div class="m-col-l-10 m-push-l-1">
{% if PAGE_HEADER %}
{{ PAGE_HEADER|replace('{filename}', FILENAME) }}
{% endif %}
{% block main %}
{% endblock %}
</div>
</div>
</div>
</article></main>
{% if not SEARCH_DISABLED %}
<div class="m-doc-search" id="search">
<a href="#!" onclick="return hideSearch()"></a>
<div class="m-container">
<div class="m-row">
<div class="m-col-m-8 m-push-m-2">
<div class="m-doc-search-header m-text m-small">
<div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
<div id="search-symbolcount">&hellip;</div>
</div>
<div class="m-doc-search-content">
<form{% if SEARCH_BASE_URL %} action="{{ SEARCH_BASE_URL }}#search"{% endif %}>
<input type="search" name="q" id="search-input" placeholder="Loading &hellip;" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
</form>
<noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.{% if SEARCH_EXTERNAL_URL %} Enable it or <a href="{{ SEARCH_EXTERNAL_URL|replace('{query}', '') }}">use an external search engine</a>.{% endif %}</noscript>
<div id="search-help" class="m-text m-dim m-text-center">
{{ SEARCH_HELP|rtrim|indent(12) }}
</div>
<div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.{% if SEARCH_EXTERNAL_URL %}<br />Maybe try a full-text <a href="#" id="search-external" data-search-engine="{{ SEARCH_EXTERNAL_URL }}">search with external engine</a>?{% endif %}</div>
<ul id="search-results"></ul>
</div>
</div>
</div>
</div>
</div>
<script src="search-v{{ SEARCHDATA_FORMAT_VERSION }}.js"></script>
{% if SEARCH_DOWNLOAD_BINARY %}
<script>
Search.download(window.location.pathname.substr(0, window.location.pathname.lastIndexOf('/') + 1) + 'searchdata-v{{ SEARCHDATA_FORMAT_VERSION }}.bin');
</script>
{% else %}
<script src="searchdata-v{{ SEARCHDATA_FORMAT_VERSION }}.js" async="async"></script>
{% endif %}
{% endif %}
{% if FINE_PRINT %}
<footer><nav>
<div class="m-container">
<div class="m-row">
<div class="m-col-l-10 m-push-l-1">
{% if FINE_PRINT == '[default]' %}
<p>{{ PROJECT_NAME }}{% if PROJECT_BRIEF %} {{ PROJECT_BRIEF }}{% endif %}. Created with {% if DOXYGEN_VERSION %}<a href="https://doxygen.org/">Doxygen</a> {{ DOXYGEN_VERSION }} and {% endif %}<a href="https://mcss.mosra.cz/">m.css</a>.</p>
{% else %}
{{ FINE_PRINT|replace('{doxygen_version}', DOXYGEN_VERSION) }}
{% endif %}
</div>
</div>
</div>
</nav></footer>
{% endif %}
</body>
</html>
{#- sanity checks for variables that should be always defined -#}
{% if FILENAME is not defined %}{{ FILENAME.is_not_defined_the_script_is_broken }}{% endif %}
{% if DOXYGEN_VERSION is not defined %}{{ DOXYGEN_VERSION.is_not_defined_the_script_is_broken }}{% endif %}
{% if SEARCHDATA_FORMAT_VERSION is not defined %}{{ SEARCHDATA_FORMAT_VERSION.is_not_defined_the_script_is_broken }}{% endif %}

View File

@@ -0,0 +1 @@
{% extends 'base-class-reference.html' %}

View File

@@ -0,0 +1,40 @@
<section class="m-doc-details" id="{{ define.id }}"><div>
<h3>
{% set j = joiner(',\n ') %}
<span class="m-doc-wrap-bumper">#define <a href="#{{ define.id }}" class="m-doc-self">{{ define.name }}</a>{% if define.params != None %}(</span><span class="m-doc-wrap">{% for param in define.params %}{{ j() }}{{ param[0] }}{% endfor %}){% endif %}{% if define.since %} {{ define.since }}{% endif %}</span>
{% if define.include %}
<div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="{{ define.include[1] }}">{{ define.include[0] }}</a></div>
{% endif %}
</h3>
{% if define.brief %}
<p>{{ define.brief }}</p>
{% endif %}
{% if define.has_param_details or define.return_value %}
<table class="m-table m-fullwidth m-flat">
{% if define.has_param_details %}
<thead>
<tr><th colspan="2">Parameters</th></tr>
</thead>
<tbody>
{% for name, description in define.params %}
<tr>
<td{% if loop.index == 1 %} style="width: 1%"{% endif %}>{{ name }}</td>
<td>{{ description }}</td>
</tr>
{% endfor %}
</tbody>
{% endif %}
{% if define.return_value %}
<tfoot>
<tr>
<th{% if not define.has_param_details %} style="width: 1%"{% endif %}>Returns</th>
<td>{{ define.return_value }}</td>
</tr>
</tfoot>
{% endif %}
</table>
{% endif %}
{% if define.description %}
{{ define.description }}
{% endif %}
</div></section>

View File

@@ -0,0 +1,46 @@
<section class="m-doc-details" id="{{ enum.id }}"><div>
<h3>
{% if compound.templates != None %}
<div class="m-doc-template">
{% set j = joiner(', ') %}
template&lt;{% for t in compound.templates %}{{ j() }}{{ t.type }} {% if t.name %}{{ t.name }}{% else %}_{{ loop.index }}{% endif %}{% endfor %}&gt;
</div>
{% endif %}
enum {% if enum.is_strong %}class {% endif %}{{ prefix }}<a href="#{{ enum.id }}" class="m-doc-self">{{ enum.name }}</a>{% if enum.type %}: {{ enum.type }}{% endif %}{% if enum.is_protected %} <span class="m-label m-warning">protected</span>{% endif %}{% if enum.since %} {{ enum.since }}{% endif %}
{# not sure why there needs to be this space #}
{% if enum.include %}
{# Template info can be only present if the enum is inside a
templated class, but in that case we have global include
information, so no need to handle case where
`enum.include and compound.templates != None` #}
<div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="{{ enum.include[1] }}">{{ enum.include[0] }}</a></div>
{% endif %}
</h3>
{% if enum.brief %}{# brief can be omitted for anonymous enums #}
<p>{{ enum.brief }}</p>
{% endif %}
{% if enum.description %}
{{ enum.description }}
{% endif %}
{% if enum.has_value_details %}
<table class="m-table m-fullwidth m-flat m-doc">
<thead><tr><th style="width: 1%">Enumerators</th><th></th></tr></thead>
<tbody>
{% for value in enum.values %}
<tr>
<td><a href="#{{ value.id }}" class="m-doc-self" id="{{ value.id }}">{{ value.name }}</a>{% if value.since %} {{ value.since }}{% endif %}</td>
<td>
{% if value.brief %}{# brief is not required for values #}
<p>{{ value.brief }}</p>
{% endif %}
{% if value.description %}{# it can be only brief tho #}
{{ value.description }}
{% endif %}
</td>
</tr>
{% endfor %}
</tbody>
</table>
{% endif %}
</div></section>

View File

@@ -0,0 +1,95 @@
<section class="m-doc-details" id="{{ func.id }}"><div>
<h3>
{% if compound.templates != None or func.templates != None %}
{% if func.include %}
<div class="m-doc-include m-code m-inverted m-right-m m-text-right"><span class="cp">#include</span> <a class="cpf" href="{{ func.include[1] }}">{{ func.include[0] }}</a></div>
{% endif %}
<div class="m-doc-template">
{% if compound.templates != None %}
{% set j = joiner(', ') %}
template&lt;{% for t in compound.templates %}{{ j() }}{{ t.type }} {% if t.name %}{{ t.name }}{% else %}_{{ loop.index }}{% endif %}{% endfor %}&gt;
{% endif %}
{% if func.templates != None %}
{% set j = joiner(', ') %}
template&lt;{% for t in func.templates %}{{ j() }}{{ t.type }}{% if t.name %} {{ t.name }}{% endif %}{% if t.default %} = {{ t.default }}{% endif %}{% endfor %}&gt;
{% endif %}
</div>
{% endif %}
{% set j = joiner(',\n ') %}
<span class="m-doc-wrap-bumper">{{ func.prefix }}{{ func.type }} {{ prefix }}</span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#{{ func.id }}" class="m-doc-self">{{ func.name }}</a>(</span><span class="m-doc-wrap">{% for param in func.params %}{{ j() }}{{ param.type_name }}{% if param.default %} = {{ param.default }}{% endif %}{% endfor %}){{ func.suffix }}{% if func.is_explicit %} <span class="m-label m-info">explicit</span> {% endif %}{% if func.is_final %} <span class="m-label m-warning">final</span>{% elif func.is_override %} <span class="m-label m-warning">override</span>{% elif func.is_pure_virtual %} <span class="m-label m-warning">pure virtual</span>{% elif func.is_virtual %} <span class="m-label m-warning">virtual</span>{% endif %}{% if func.is_protected %} <span class="m-label m-warning">protected{% if func.is_slot %} slot{% endif %}</span>{% elif func.is_private %} <span class="m-label m-danger">private{% if func.is_slot %} slot{% endif %}</span>{% elif func.is_signal %} <span class="m-label m-success">signal</span>{% elif func.is_slot %} <span class="m-label m-success">public slot</span>{% endif %}{% if func.is_defaulted %} <span class="m-label m-info">defaulted</span>{% endif %}{% if func.is_deleted %} <span class="m-label m-danger">deleted</span>{% endif %}{% if func.is_constexpr %} <span class="m-label m-primary">constexpr</span>{% endif %}{% if func.is_conditional_noexcept %} <span class="m-label m-success">noexcept(…)</span>{% elif func.is_noexcept %} <span class="m-label m-success">noexcept</span>{% endif %}{% if func.since %} {{ func.since }}{% endif %}</span></span>
{% if func.include and compound.templates == None and func.templates == None %}
<div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="{{ func.include[1] }}">{{ func.include[0] }}</a></div>
{% endif %}
</h3>
{% if func.brief %}
<p>{{ func.brief }}</p>
{% endif %}
{% if func.has_template_details or func.has_param_details or func.return_value or func.return_values or func.exceptions %}
<table class="m-table m-fullwidth m-flat">
{% if func.has_template_details %}
<thead>
<tr><th colspan="2">Template parameters</th></tr>
</thead>
<tbody>
{% for template in func.templates|selectattr('name') %}
<tr>
<td{% if loop.index == 1 %} style="width: 1%"{% endif %}>{{ template.name }}</td>
<td>{{ template.description }}</td>
</tr>
{% endfor %}
</tbody>
{% endif %}
{% if func.has_param_details %}
<thead>
<tr><th colspan="2">Parameters</th></tr>
</thead>
<tbody>
{% for param in func.params|selectattr('name') %}
<tr>
<td{% if loop.index == 1 and not func.has_template_details %} style="width: 1%"{% endif %}>{{ param.name }}{% if param.direction == 'in' %}&nbsp;<span class="m-label m-flat m-info">in</span>{% elif param.direction == 'out' %}&nbsp;<span class="m-label m-flat m-warning">out</span>{% elif param.direction == 'inout' %}&nbsp;<span class="m-label m-flat m-danger">in/out</span>{% endif %}</td>
<td>{{ param.description }}</td>
</tr>
{% endfor %}
</tbody>
{% endif %}
{% if func.return_value %}
{{ '<thead>' if func.return_values or func.exceptions else '<tfoot>' }}
<tr>
<th{% if not func.has_template_details and not func.has_param_details %} style="width: 1%"{% endif %}>Returns</th>
<td>{{ func.return_value }}</td>
</tr>
{{ '</thead>' if func.return_values or func.exceptions else '</tfoot>' }}
{% elif func.return_values %}
<thead>
<tr><th colspan="2">Returns</th></tr>
</thead>
{% endif %}
{% if func.return_values %}
<tbody>
{% for value, description in func.return_values %}
<tr>
<td{% if loop.index == 1 and not func.has_template_details and not func.has_param_details and not func.return_value %} style="width: 1%"{% endif %}>{{ value }}</td>
<td>{{ description }}</td>
</tr>
{% endfor %}
</tbody>
{% endif %}
{% if func.exceptions %}
<thead>
<tr><th colspan="2">Exceptions</th></tr>
</thead>
<tbody>
{% for exception, description in func.exceptions %}
<tr>
<td{% if loop.index == 1 and not func.has_template_details and not func.has_param_details and not func.return_value and not func.return_values %} style="width: 1%"{% endif %}>{{ exception }}</td>
<td>{{ description }}</td>
</tr>
{% endfor %}
</tbody>
{% endif %}
</table>
{% endif %}
{% if func.description %}
{{ func.description }}
{% endif %}
</div></section>

View File

@@ -0,0 +1,50 @@
<section class="m-doc-details" id="{{ typedef.id }}"><div>
<h3>
{% if compound.templates != None or typedef.templates != None %}
{% if typedef.include %}
<div class="m-doc-include m-code m-inverted m-right-m m-text-right"><span class="cp">#include</span> <a class="cpf" href="{{ typedef.include[1] }}">{{ typedef.include[0] }}</a></div>
{% endif %}
<div class="m-doc-template">
{% if compound.templates != None %}
{% set j = joiner(', ') %}
template&lt;{% for t in compound.templates %}{{ j() }}{{ t.type }} {% if t.name %}{{ t.name }}{% else %}_{{ loop.index }}{% endif %}{% endfor %}&gt;
{% endif %}
{% if typedef.templates != None %}
{% set j = joiner(', ') %}
template&lt;{% for t in typedef.templates %}{{ j() }}{{ t.type }}{% if t.name %} {{ t.name }}{% endif %}{% if t.default %} = {{ t.default }}{% endif %}{% endfor %}&gt;
{% endif %}
</div>
{% endif %}
{% if typedef.is_using %}
using {{ prefix }}<a href="#{{ typedef.id }}" class="m-doc-self">{{ typedef.name }}</a> = {{ typedef.type }}{{ typedef.args }}{% if typedef.is_protected %} <span class="m-label m-warning">protected</span>{% endif %}{% if typedef.since %} {{ typedef.since }}{% endif %}
{% else %}
typedef {{ typedef.type }}{% if not typedef.args %} {% endif %}{{ prefix }}<a href="#{{ typedef.id }}" class="m-doc-self">{{ typedef.name }}</a>{{ typedef.args }}{% if typedef.is_protected %} <span class="m-label m-warning">protected</span>{% endif %}{% if typedef.since %} {{ typedef.since }}{% endif %}
{% endif %}
{# the empty line has to be here to prevent the lines from merging #}
{% if typedef.include and compound.templates == None and typedef.templates == None %}
<div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="{{ typedef.include[1] }}">{{ typedef.include[0] }}</a></div>
{% endif %}
</h3>
{% if typedef.brief %}
<p>{{ typedef.brief }}</p>
{% endif %}
{% if typedef.has_template_details %}
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Template parameters</th></tr>
</thead>
<tbody>
{% for template in typedef.templates|selectattr('name') %}
<tr>
<td{% if loop.index == 1 %} style="width: 1%"{% endif %}>{{ template.name }}</td>
<td>{{ template.description }}</td>
</tr>
{% endfor %}
</tbody>
</table>
{% endif %}
{% if typedef.description %}
{{ typedef.description }}
{% endif %}
</div></section>

View File

@@ -0,0 +1,46 @@
<section class="m-doc-details" id="{{ var.id }}"><div>
<h3>
{% if compound.templates != None or var.templates != None %}
{% if var.include %}
<div class="m-doc-include m-code m-inverted m-right-m m-text-right"><span class="cp">#include</span> <a class="cpf" href="{{ var.include[1] }}">{{ var.include[0] }}</a></div>
{% endif %}
<div class="m-doc-template">
{% if compound.templates != None %}
{% set j = joiner(', ') %}
template&lt;{% for t in compound.templates %}{{ j() }}{{ t.type }} {% if t.name %}{{ t.name }}{% else %}_{{ loop.index }}{% endif %}{% endfor %}&gt;
{% endif %}
{% if var.templates != None %}
{% set j = joiner(', ') %}
template&lt;{% for t in var.templates %}{{ j() }}{{ t.type }}{% if t.name %} {{ t.name }}{% endif %}{% if t.default %} = {{ t.default }}{% endif %}{% endfor %}&gt;
{% endif %}
</div>
{% endif %}
{%+ if var.is_static %}static {% endif %}{{ var.type }} {{ prefix }}<a href="#{{ var.id }}" class="m-doc-self">{{ var.name }}</a>{% if var.is_protected %} <span class="m-label m-warning">protected</span>{% endif %}{% if var.is_constexpr %} <span class="m-label m-primary">constexpr</span>{% endif %}{% if var.since %} {{ var.since }}{% endif %}
{# the empty line needs to be here to prevent the lines from merging #}
{% if var.include and compound.templates == None and var.templates == None %}
<div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="{{ var.include[1] }}">{{ var.include[0] }}</a></div>
{% endif %}
</h3>
{% if var.brief %}
<p>{{ var.brief }}</p>
{% endif %}
{% if var.has_template_details %}
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Template parameters</th></tr>
</thead>
<tbody>
{% for template in var.templates|selectattr('name') %}
<tr>
<td{% if loop.index == 1 %} style="width: 1%"{% endif %}>{{ template.name }}</td>
<td>{{ template.description }}</td>
</tr>
{% endfor %}
</tbody>
</table>
{% endif %}
{% if var.description %}
{{ var.description }}
{% endif %}
</div></section>

View File

@@ -0,0 +1,11 @@
{% extends 'base-reference.html' %}
{% block title %}{% for name, _ in compound.breadcrumb %}{{ name }}/{% endfor %} directory | {{ super() }}{% endblock %}
{% block header %}
<h1>
{%+ for name, target in compound.breadcrumb[:-1] %}<span class="m-breadcrumb"><a href="{{ target }}">{{ name }}</a>/</span>{% endfor %}{{ compound.breadcrumb[-1][0] }}<span class="m-breadcrumb">/</span> <span class="m-thin">directory</span>{% if compound.since %} {{ compound.since }}{% endif %}
{# need an explicit space here otherwise the newline gets removed #}
</h1>
{% endblock %}

View File

@@ -0,0 +1,10 @@
<dt>
{% if class.templates != None %}
{% set j = joiner(', ') %}
<div class="m-doc-template">template&lt;{% for t in class.templates %}{{ j() }}{{ t.type }}{% if t.name %} {{ t.name }}{% endif %}{% if t.default %} = {{ t.default }}{% endif %}{% endfor %}&gt;</div>
{% endif %}
{{ class.kind }} <a href="{{ class.url }}" class="m-doc">{{ class.name }}</a>{% if class.is_protected %} <span class="m-label m-flat m-warning">protected</span>{% endif %}{% if class.is_final %} <span class="m-label m-flat m-warning">final</span>{% elif class.is_virtual %} <span class="m-label m-flat m-warning">virtual</span>{% endif %}{% if class.deprecated %} <span class="m-label m-danger">{{ class.deprecated }}</span>{% endif %}{% if class.since %} {{ class.since }}{% endif %}
{# the empty line is above to fix spacing #}
</dt>
<dd>{{ class.brief }}</dd>

View File

@@ -0,0 +1,5 @@
<dt{% if not define.has_details and define.base_url == compound.url %} id="{{ define.id }}"{% endif %}>
{% set j = joiner(',\n ') %}
<span class="m-doc-wrap-bumper">#define <a href="{% if define.base_url != compound.url %}{{ define.base_url }}{% endif %}#{{ define.id }}" class="m-doc{% if not define.has_details and define.base_url == compound.url %}-self{% endif %}">{{ define.name }}</a>{% if define.params != None %}(</span><span class="m-doc-wrap">{% for param in define.params %}{{ j() }}{{ param[0] }}{% endfor %}){% endif %}{% if define.deprecated %} <span class="m-label m-danger">{{ define.deprecated }}</span>{% endif %}{% if define.since %} {{ define.since }}{% endif %}</span>
</dt>
<dd>{{ define.brief }}</dd>

View File

@@ -0,0 +1,2 @@
<dt>directory <a href="{{ dir.url }}" class="m-doc">{{ dir.name }}</a>/{% if dir.deprecated %} <span class="m-label m-danger">{{ dir.deprecated }}</span>{% endif %}{% if dir.since %} {{ dir.since }}{% endif %}</dt>
<dd>{{ dir.brief }}</dd>

View File

@@ -0,0 +1,5 @@
<dt{% if not enum.has_details and enum.base_url == compound.url %} id="{{ enum.id }}"{% endif %}>
{% set j = joiner(',\n ') %}
<span class="m-doc-wrap-bumper">enum {% if enum.is_strong %}class {% endif %}<a href="{% if enum.base_url != compound.url %}{{ enum.base_url }}{% endif %}#{{ enum.id }}" class="m-doc{% if not enum.has_details and enum.base_url == compound.url %}-self{% endif %}">{{ enum.name }}</a>{% if enum.type %}: {{ enum.type }}{% endif %} { </span><span class="m-doc-wrap">{% for value in enum.values %}{{ j() }}<a href="#{{ value.id }}" class="m-doc">{{ value.name }}</a>{% if value.initializer %} {{ value.initializer }}{% endif %}{% if value.since %} {{ value.since }}{% endif %}{% if value.deprecated %} <span class="m-label m-danger">{{ value.deprecated }}</span>{% endif %}{% endfor %} }{% if enum.deprecated %} <span class="m-label m-danger">{{ enum.deprecated }}</span>{% endif %}{% if mark_nonpublic and enum.is_protected %} <span class="m-label m-flat m-warning">protected</span>{% endif %}{% if enum.since %} {{ enum.since }}{% endif %}</span>
</dt>
<dd>{{ enum.brief }}</dd>

View File

@@ -0,0 +1,2 @@
<dt>file <a href="{{ file.url }}" class="m-doc">{{ file.name }}</a>{% if file.deprecated %} <span class="m-label m-danger">{{ file.deprecated }}</span>{% endif %}{% if file.since %} {{ file.since }}{% endif %}</dt>
<dd>{{ file.brief }}</dd>

View File

@@ -0,0 +1,9 @@
<dt{% if not func.has_details and func.base_url == compound.url %} id="{{ func.id }}"{% endif %}>
{% if func.templates != None %}
{% set j = joiner(', ') %}
<div class="m-doc-template">template&lt;{% for t in func.templates %}{{ j() }}{{ t.type }}{% if t.name %} {{ t.name }}{% endif %}{% if t.default %} = {{ t.default }}{% endif %}{% endfor %}&gt;</div>
{% endif %}
{% set j = joiner(',\n ') %}
<span class="m-doc-wrap-bumper">{{ func.prefix }}{% if func.type == 'void' %}void {% elif func.type %}auto {% endif %}<a href="{% if func.base_url != compound.url %}{{ func.base_url }}{% endif %}#{{ func.id }}" class="m-doc{% if not func.has_details and func.base_url == compound.url %}-self{% endif %}">{{ func.name }}</a>(</span><span class="m-doc-wrap">{% for param in func.params %}{{ j() }}{{ param.type_name }}{% if param.default %} = {{ param.default }}{% endif %}{% endfor %}){{ func.suffix }}{% if func.type and func.type != 'void' %} -&gt; {{ func.type }}{% endif %}{% if func.deprecated %} <span class="m-label m-danger">{{ func.deprecated }}</span>{% endif %}{% if not func.type or mark_nonpublic %}{% if func.is_protected %} <span class="m-label m-flat m-warning">protected{% if func.is_slot %} slot{% endif %}</span>{% elif func.is_private %} <span class="m-label m-flat m-danger">private{% if func.is_slot %} slot{% endif %}</span>{% elif func.is_signal %} <span class="m-label m-flat m-success">signal</span>{% elif func.is_slot %} <span class="m-label m-flat m-success">public slot</span>{% endif %}{% endif %}{% if func.is_defaulted %} <span class="m-label m-flat m-info">defaulted</span>{% endif %}{% if func.is_deleted %} <span class="m-label m-flat m-danger">deleted</span>{% endif %}{% if func.is_explicit %} <span class="m-label m-flat m-info">explicit</span> {% endif %}{% if func.is_final %} <span class="m-label m-flat m-warning">final</span>{% elif func.is_override %} <span class="m-label m-flat m-warning">override</span>{% elif func.is_pure_virtual %} <span class="m-label m-flat m-warning">pure virtual</span>{% elif func.is_virtual %} <span class="m-label m-flat m-warning">virtual</span>{% endif %}{% if func.is_constexpr %} <span class="m-label m-flat m-primary">constexpr</span>{% endif %}{% if func.is_conditional_noexcept %} <span class="m-label m-flat m-success">noexcept(…)</span>{% elif func.is_noexcept %} <span class="m-label m-flat m-success">noexcept</span>{% endif %}{% if func.since %} {{ func.since }}{% endif %}</span>
</dt>
<dd>{{ func.brief }}</dd>

View File

@@ -0,0 +1,2 @@
<dt>module <a href="{{ module.url }}" class="m-doc">{{ module.name }}</a>{% if module.deprecated %} <span class="m-label m-danger">{{ module.deprecated }}</span>{% endif %}{% if module.since %} {{ module.since }}{% endif %}</dt>
<dd>{{ module.brief }}</dd>

View File

@@ -0,0 +1,2 @@
<dt>namespace <a href="{{ namespace.url }}" class="m-doc">{{ namespace.name }}</a>{% if namespace.is_inline %} <span class="m-label m-flat m-info">inline</span>{% endif %}{% if namespace.deprecated %} <span class="m-label m-danger">{{ namespace.deprecated }}</span>{% endif %}{% if namespace.since %} {{ namespace.since }}{% endif %}</dt>
<dd>{{ namespace.brief }}</dd>

View File

@@ -0,0 +1,10 @@
<dt{% if not typedef.has_details and typedef.base_url == compound.url %} id="{{ typedef.id }}"{% endif %}>
{% if typedef.templates != None %}
{% set j = joiner(', ') %}
<div class="m-doc-template">template&lt;{% for t in typedef.templates %}{{ j() }}{{ t.type }}{% if t.name %} {{ t.name }}{% endif %}{% if t.default %} = {{ t.default }}{% endif%}{% endfor %}&gt;</div>
{% endif %}
using <a href="{% if typedef.base_url != compound.url %}{{ typedef.base_url }}{% endif %}#{{ typedef.id }}" class="m-doc{% if not typedef.has_details and typedef.base_url == compound.url %}-self{% endif %}">{{ typedef.name }}</a> = {{ typedef.type }}{{ typedef.args }}{% if typedef.deprecated %} <span class="m-label m-danger">{{ typedef.deprecated }}</span>{% endif %}{% if mark_nonpublic and typedef.is_protected %} <span class="m-label m-flat m-warning">protected</span>{% endif %}{% if typedef.since %} {{ typedef.since }}{% endif %}
{# This empty line needs to be there otherwise it's eaten #}
</dt>
<dd>{{ typedef.brief }}</dd>

View File

@@ -0,0 +1,10 @@
<dt{% if not var.has_details and var.base_url == compound.url %} id="{{ var.id }}"{% endif %}>
{% if var.templates != None %}
{% set j = joiner(', ') %}
<div class="m-doc-template">template&lt;{% for t in var.templates %}{{ j() }}{{ t.type }}{% if t.name %} {{ t.name }}{% endif %}{% if t.default %} = {{ t.default }}{% endif%}{% endfor %}&gt;</div>
{% endif %}
{%+ if var.is_static %}static {% endif %}{{ var.type }} <a href="{% if var.base_url != compound.url %}{{ var.base_url }}{% endif %}#{{ var.id }}" class="m-doc{% if not var.has_details and var.base_url == compound.url %}-self{% endif %}">{{ var.name }}</a>{% if var.deprecated %} <span class="m-label m-danger">{{ var.deprecated }}</span>{% endif %}{% if mark_nonpublic and var.is_protected %} <span class="m-label m-flat m-warning">protected</span>{% endif %}{% if var.is_constexpr %} <span class="m-label m-flat m-primary">constexpr</span>{% endif %}{% if var.since %} {{ var.since }}{% endif %}
{# This empty line needs to be there otherwise it's eaten #}
</dt>
<dd>{{ var.brief }}</dd>

View File

@@ -0,0 +1,30 @@
{% extends 'base.html' %}
{% block title %}{% set j = joiner(' &raquo; ') %}{% for name, _ in compound.breadcrumb %}{{ j() }}{{ name }}{% endfor %} source | {{ super() }}{% endblock %}
{% block header_links %}
{% if compound.footer_navigation and compound.footer_navigation[0] %}
<link rel="prev" href="{{ compound.footer_navigation[0][0] }}" />
{% endif %}
{% if compound.footer_navigation and compound.footer_navigation[2] %}
<link rel="next" href="{{ compound.footer_navigation[2][0] }}" />
{% endif %}
{% endblock %}
{% block main %}
<h1>
{% for name, target in compound.breadcrumb[:-1] %}
<span class="m-breadcrumb"><a href="{{ target }}">{{ name }}</a> &raquo;</span>
{% endfor %}
{{ compound.breadcrumb[-1][0] }} <span class="m-thin">source</span>
</h1>
{% if compound.brief %}
<p>{{ compound.brief }}</p>
{% endif %}
{% if compound.description %}
{{ compound.description }}
{% endif %}
{% if compound.footer_navigation %}
<div class="m-note m-dim m-thin m-text-center">{% if compound.footer_navigation[0] %}<a href="{{ compound.footer_navigation[0][0] }}" class="m-doc">&laquo; {{ compound.footer_navigation[0][1] }}</a> | {% endif %}<a href="{{ compound.footer_navigation[1][0] }}" class="m-doc">{{ compound.footer_navigation[1][1] }}</a>{% if compound.footer_navigation[2] %} | <a href="{{ compound.footer_navigation[2][0] }}" class="m-doc">{{ compound.footer_navigation[2][1] }} &raquo;</a>{% endif %}</div>
{% endif %}
{% endblock %}

View File

@@ -0,0 +1,11 @@
{% extends 'base-reference.html' %}
{% block title %}{% set j = joiner('/') %}{% for name, _ in compound.breadcrumb %}{{ j() }}{{ name }}{% endfor %} file | {{ super() }}{% endblock %}
{% block header %}
<h1>
{%+ for name, target in compound.breadcrumb[:-1] %}<span class="m-breadcrumb"><a href="{{ target }}">{{ name }}</a>/</span>{% endfor %}{{ compound.breadcrumb[-1][0] }} <span class="m-thin">file</span>{% if compound.since %} {{ compound.since }}{% endif %}
{# need an explicit space here otherwise the newline gets removed #}
</h1>
{% endblock %}

View File

@@ -0,0 +1,21 @@
{% set navbar_current = 'files' %}
{% extends 'base-index.html' %}
{% block main %}
<h1>Files</h1>
<ul class="m-doc">
{% for i in index.files recursive %}
{% if i.children %}
<li class="m-doc-collapsible{% if loop.depth > FILE_INDEX_EXPAND_LEVELS %} collapsed{% endif %}">
<a href="#" onclick="return toggle(this)">{{ i.kind }}</a> <a href="{{ i.url }}" class="m-doc">{{ i.name }}</a>{% if i.deprecated %} <span class="m-label m-danger">{{ i.deprecated }}</span>{% endif %}{% if i.since %} {{ i.since }}{% endif %} <span class="m-doc">{{ i.brief }}</span>
<ul class="m-doc">
{{ loop(i.children)|rtrim|indent(4, true) }}
</ul>
</li>
{% else %}
<li>{{ i.kind }} <a href="{{ i.url }}" class="m-doc">{{ i.name }}</a>{% if i.deprecated %} <span class="m-label m-danger">{{ i.deprecated }}</span>{% endif %}{% if i.since %} {{ i.since }}{% endif %} <span class="m-doc">{{ i.brief }}</span></li>
{% endif %}
{% endfor %}
</ul>
{{ super() -}}
{% endblock %}

View File

@@ -0,0 +1,11 @@
{% extends 'base-reference.html' %}
{% block title %}{% set j = joiner(' &raquo; ') %}{% for name, _ in compound.breadcrumb %}{{ j() }}{{ name }}{% endfor %} module | {{ super() }}{% endblock %}
{% block header %}
<h1>
{% for name, target in compound.breadcrumb[:-1] %}
<span class="m-breadcrumb"><a href="{{ target }}">{{ name }}</a> &raquo;</span>
{% endfor %}
{{ compound.breadcrumb[-1][0] }} <span class="m-thin">module</span>{% if compound.since %} {{ compound.since }}{% endif %}</h1>
{% endblock %}

View File

@@ -0,0 +1,21 @@
{% set navbar_current = 'modules' %}
{% extends 'base-index.html' %}
{% block main %}
<h1>Modules</h1>
<ul class="m-doc">
{% for i in index.modules recursive %}
{% if i.has_nestable_children %}
<li class="m-doc-collapsible">
<a href="#" onclick="return toggle(this)">module</a> <a href="{{ i.url }}" class="m-doc">{{ i.name }}</a>{% if i.deprecated %} <span class="m-label m-danger">{{ i.deprecated }}</span>{% endif %}{% if i.since %} {{ i.since }}{% endif %} <span class="m-doc">{{ i.brief }}</span>
<ul class="m-doc">
{{ loop(i.children)|rtrim|indent(4, true) }}
</ul>
</li>
{% else %}
<li>module <a href="{{ i.url }}" class="m-doc">{{ i.name }}</a>{% if i.deprecated %} <span class="m-label m-danger">{{ i.deprecated }}</span>{% endif %}{% if i.since %} {{ i.since }}{% endif %} <span class="m-doc">{{ i.brief }}</span></li>
{% endif %}
{% endfor %}
</ul>
{{ super() -}}
{% endblock %}

View File

@@ -0,0 +1,14 @@
{% extends 'base-reference.html' %}
{% block title %}{% set j = joiner('::') %}{% for name, _ in compound.breadcrumb %}{{ j() }}{{ name }}{% endfor %} namespace | {{ super() }}{% endblock %}
{% block header %}
<h1>
{%+ for name, target in compound.breadcrumb[:-1] %}<span class="m-breadcrumb"><a href="{{ target }}">{{ name }}</a>::<wbr/></span>{% endfor %}{{ compound.breadcrumb[-1][0] }} <span class="m-thin">namespace</span>{% if compound.is_inline %} <span class="m-label m-flat m-info">inline</span>{% endif %}{% if compound.since %} {{ compound.since }}{% endif %}
{# need an explicit space here otherwise the newline gets removed #}
{% if compound.include %}
<div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="{{ compound.include[1] }}">{{ compound.include[0] }}</a></div>
{% endif %}
</h1>
{% endblock %}

View File

@@ -0,0 +1,21 @@
{% set navbar_current = 'namespaces' %}
{% extends 'base-index.html' %}
{% block main %}
<h1>Namespaces</h1>
<ul class="m-doc">
{% for i in index.symbols|selectattr('kind', 'equalto', 'namespace') recursive %}
{% if i.has_nestable_children %}
<li class="m-doc-collapsible">
<a href="#" onclick="return toggle(this)">{{ i.kind }}</a> <a href="{{ i.url }}" class="m-doc">{{ i.name }}</a>{% if i.is_inline %} <span class="m-label m-flat m-info">inline</span>{% endif %}{% if i.deprecated %} <span class="m-label m-danger">{{ i.deprecated }}</span>{% endif %}{% if i.since %} {{ i.since }}{% endif %} <span class="m-doc">{{ i.brief }}</span>
<ul class="m-doc">
{{ loop(i.children|selectattr('kind', 'equalto', 'namespace'))|rtrim|indent(4, true) }}
</ul>
</li>
{% else %}
<li>{{ i.kind }} <a href="{{ i.url }}" class="m-doc">{{ i.name }}</a>{% if i.is_inline %} <span class="m-label m-flat m-info">inline</span>{% endif %}{% if i.deprecated %} <span class="m-label m-danger">{{ i.deprecated }}</span>{% endif %}{% if i.since %} {{ i.since }}{% endif %} <span class="m-doc">{{ i.brief }}</span></li>
{% endif %}
{% endfor %}
</ul>
{{ super() -}}
{% endblock %}

View File

@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/">
<ShortName>{{ PROJECT_NAME }}{% if PROJECT_BRIEF %} {{ PROJECT_BRIEF }}{% endif %}</ShortName>
<Description>Search {{ PROJECT_NAME }} documentation</Description>
{% if FAVICON %}
<Image type="{{ FAVICON[1] }}">{{ SEARCH_BASE_URL|urljoin(FAVICON[0])|e }}</Image>
{% endif %}
<Url type="text/html" template="{{ SEARCH_BASE_URL }}?q={searchTerms}#search"/>
</OpenSearchDescription>

View File

@@ -0,0 +1,51 @@
{% extends 'base.html' %}
{% block title %}{% if 1 in compound.breadcrumb or compound.breadcrumb[-1][0] != PROJECT_NAME %}{% set j = joiner(' &raquo; ') %}{% for name, _ in compound.breadcrumb %}{{ j() }}{{ name }}{% endfor %} | {{ super() }}{% else %}{{ super() }}{% endif %}{% endblock %}
{% block header_links %}
{% if compound.footer_navigation and compound.footer_navigation[0] %}
<link rel="prev" href="{{ compound.footer_navigation[0][0] }}" />
{% endif %}
{% if compound.footer_navigation and compound.footer_navigation[2] %}
<link rel="next" href="{{ compound.footer_navigation[2][0] }}" />
{% endif %}
{% endblock %}
{% block main %}
<h1>
{% for name, target in compound.breadcrumb[:-1] %}
<span class="m-breadcrumb"><a href="{{ target }}">{{ name }}</a> &raquo;</span>
{% endfor %}
{{ compound.breadcrumb[-1][0] }}{% if compound.since %} {{ compound.since }}{% endif %}
{# need an explicit space here otherwise the newline gets removed #}
</h1>
{% if compound.brief %}
<p>{{ compound.brief }}</p>
{% endif %}
{% if compound.sections %}
<div class="m-block m-default">
<h3>Contents</h3>
<ul>
{% for id, name, children in compound.sections recursive %}
{% if children %}
<li>
<a href="#{{ id }}">{{ name }}</a>
<ul>
{{ loop(children)|rtrim|indent(4, true) }}
</ul>
</li>
{% else %}
<li><a href="#{{ id }}">{{ name }}</a></li>
{% endif %}
{% endfor %}
</ul>
</div>
{% endif %}
{% if compound.description %}
{{ compound.description }}
{% endif %}
{% if compound.footer_navigation %}
<div class="m-note m-dim m-thin m-text-center">{% if compound.footer_navigation[0] %}<a href="{{ compound.footer_navigation[0][0] }}" class="m-doc">&laquo; {{ compound.footer_navigation[0][1] }}</a> | {% endif %}<a href="{{ compound.footer_navigation[1][0] }}" class="m-doc">{{ compound.footer_navigation[1][1] }}</a>{% if compound.footer_navigation[2] %} | <a href="{{ compound.footer_navigation[2][0] }}" class="m-doc">{{ compound.footer_navigation[2][1] }} &raquo;</a>{% endif %}</div>
{% endif %}
{% endblock %}

View File

@@ -0,0 +1,21 @@
{% set navbar_current = 'pages' %}
{% extends 'base-index.html' %}
{% block main %}
<h1>Pages</h1>
<ul class="m-doc">
{% for i in index.pages recursive %}
{% if i.children %}
<li class="m-doc-collapsible">
<a href="#" onclick="return toggle(this)"></a><a href="{{ i.url }}" class="m-doc">{{ i.name }}</a>{% if i.deprecated %} <span class="m-label m-danger">{{ i.deprecated }}</span>{% endif %}{% if i.since %} {{ i.since }}{% endif %} <span class="m-doc">{{ i.brief }}</span>
<ul class="m-doc">
{{ loop(i.children)|rtrim|indent(4, true) }}
</ul>
</li>
{% else %}
<li><a href="{{ i.url }}" class="m-doc">{{ i.name }}</a>{% if i.deprecated %} <span class="m-label m-danger">{{ i.deprecated }}</span>{% endif %}{% if i.since %} {{ i.since }}{% endif %} <span class="m-doc">{{ i.brief }}</span></li>
{% endif %}
{% endfor %}
</ul>
{{ super() -}}
{% endblock %}

View File

@@ -0,0 +1 @@
{% extends 'base-class-reference.html' %}

View File

@@ -0,0 +1 @@
{% extends 'base-class-reference.html' %}