diff options
Diffstat (limited to 'templates/html/htmlnamespace.tpl')
| -rw-r--r-- | templates/html/htmlnamespace.tpl | 206 |
1 files changed, 206 insertions, 0 deletions
diff --git a/templates/html/htmlnamespace.tpl b/templates/html/htmlnamespace.tpl new file mode 100644 index 0000000..e21ba9d --- /dev/null +++ b/templates/html/htmlnamespace.tpl @@ -0,0 +1,206 @@ +{% extend 'htmlbase.tpl' %} +{% msg %}Generating HTML output for namespace {{ compound.name }}{% endmsg %} + +{% block navpath %} +{% with navpath=compound.navigationPath %} + {% include 'htmlnavpath.tpl' %} +{% endwith %} +{% endblock %} + +{% block title %} + {# write summary links in the title area #} + <div class="summary"> + {% with first=True %} + {% if compound.classes %} + <a href="#nested-classes">{{ tr.classes }}</a> + {% set first=False %} + {% endif %} + {% if compound.namespaces %} + {% if not first %} | {% endif %} + <a href="#namespaces">{{ tr.namespaces }}</a> + {% set first=False %} + {% endif %} + {% if compound.constantgroups %} + {% if not first %} | {% endif %} + <a href="#constantgroups">{{ tr.constantgroups }}</a> + {% set first=False %} + {% endif %} + {% with memberListInfo=compound.typedefs %} + {% include 'htmlmemsummary.tpl' %} + {% endwith %} + {% with memberListInfo=compound.enums %} + {% include 'htmlmemsummary.tpl' %} + {% endwith %} + {% with memberListInfo=compound.functions %} + {% include 'htmlmemsummary.tpl' %} + {% endwith %} + {% with memberListInfo=compound.variables %} + {% include 'htmlmemsummary.tpl' %} + {% endwith %} + {% endwith %} + </div> + {{ block.super }} +{% endblock %} + +{% block content %} +<div class="contents"> +{# brief description #} + {% if compound.brief %} + {{ compound.brief }} + {% if compound.hasDetails %} + <a href="#details">{{ tr.more }}</a> + {% endif %} + {% endif %} +{# member declarations #} + {# classes #} + {% with list=compound.classes label='nested-classes' title=tr.classes local=False %} + {% include 'htmldeclcomp.tpl' %} + {% endwith %} + {# namespaces #} + {% with list=compound.namespaces, label='namespaces' title=tr.namespaces local=False %} + {% include 'htmldeclcomp.tpl' %} + {% endwith %} + {# constantgroups #} + {% with list=compound.constantgroups, label='constantgroups' title=tr.constantgroups local=False %} + {% include 'htmldeclcomp.tpl' %} + {% endwith %} + {# typedefs #} + {% with memberListInfo=compound.typedefs %} + {% include 'htmlmemdecls.tpl' %} + {% endwith %} + {# enums #} + {% with memberListInfo=compound.enums %} + {% include 'htmlmemdecls.tpl' %} + {% endwith %} + {# functions #} + {% with memberListInfo=compound.functions %} + {% include 'htmlmemdecls.tpl' %} + {% endwith %} + {# variables #} + {% with memberListInfo=compound.variables %} + {% include 'htmlmemdecls.tpl' %} + {% endwith %} + {# membergroups #} + {% if compound.memberGroups %} + {% for memberListInfo in compound.memberGroups %} + {% include 'htmlmemdecls.tpl' %} + {% endfor %} + {% endif %} +{# end member declarations #} +{# detailed description #} +{% if compound.hasDetails %} + {# anchor #} + <a name="details" id="details"></a> + {# header #} + <h2 class="groupheader">{{ tr.detailedDesc }}</h2> + <div class="textblock"> + {# brief #} + {% if compound.brief and config.REPEAT_BRIEF %} + <p> + {{ compound.brief }} + </p> + {% endif %} + {# details #} + {{ compound.details }} + {# source definition #} + {% if compound.sourceDef %} + {% markers obj in compound.sourceDef with tr.definedAtLineInSourceFile %} + {% with text=obj.text %} + {% include 'htmlobjlink.tpl' %} + {% endwith %} + {% endmarkers %} + {% endif %} + </div> +{% endif %} +{# member definitions #} + {# inline classes #} + {% if compound.inlineClasses %} + <h2 class="groupheader">{{ tr.classDocumentation }}</h2> + {% for class in compound.inlineClasses %} + {# write anchor #} + <a class="anchor" id="{{ class.anchor }}"></a> + <div class="memitem"> + <div class="memproto"> + <table class="memname"> + <tr><td class="memname">{{ class.compoundType }} {{ class.name }}</td></tr> + </table> + </div> + <div class="memdoc"> + <div class="textblock"> + {# TODO: the stuff inside textblock can be the same as in htmlclass.tpl!! #} + {# template specifier #} + {% if class.language=='cpp' and class.templateDecls %} + <h3>{% spaceless %} + {% for targList in class.templateDecls %} + template< + {% for targ in targList %} + {{ targ.type }}{% if targ.name %} {{ targ.name }}{% endif %}{% if targ.defVal %} = {{ targ.defVal }}{% endif %}{% if not forloop.last %}, {% endif %} + {% endfor %} + ><br/> + {% endfor %} + {% endspaceless %} + {{ class.classType }} {{ class.name }} + </h3> + {% endif %} + {# brief description #} + {% if class.brief and config.REPEAT_BRIEF %} + <p>{{ class.brief }}</p> + {% endif %} + {# detailed docs #} + {{ class.details }} + {# source def #} + {% if class.sourceDef %} + {% markers obj in class.sourceDef with tr.definedAtLineInSourceFile %} + {% with text=obj.text %} + {% include 'htmlobjlink.tpl' %} + {% endwith %} + {% endmarkers %} + {% endif %} + </div><!-- textblock --> + {# table with fields #} + <table class="fieldtable"> + <tr><th colspan="3">{{ tr.compoundMembers }}</td></tr> + {% for member in class.members %} + <tr><td class="fieldtype"> + <a class="anchor" id="{{ member.anchor }}"></a>{{ member.fieldType }} + </td> + <td class="fieldname"> + {{ member.name }} + {% if member.isVariable and member.declArgs %}{{ member.declArgs }}{% endif %} + {{ member.bitfields }} + </td> + <td class="fielddoc"> + {% if member.brief and not member.details %}{# only brief #} + {{ member.brief }} + {% else %} {# only details or both #} + {% if member.brief %}<p>{{ member.brief }}</p>{% endif %} + {{ member.details }} + {% endif %} + </td> + </tr> + {% endfor %} + </table> + </div><!-- memdoc --> + </div><!-- memitem --> + {% endfor %} + {% endif %} + {# typedefs #} + {% with memberListInfo=compound.detailedTypedefs %} + {% include 'htmlmemdef.tpl' %} + {% endwith %} + {# enums #} + {% with memberListInfo=compound.detailedEnums %} + {% include 'htmlmemdef.tpl' %} + {% endwith %} + {# functions #} + {% with memberListInfo=compound.detailedFunctions %} + {% include 'htmlmemdef.tpl' %} + {% endwith %} + {# variables #} + {% with memberListInfo=compound.detailedVariables %} + {% include 'htmlmemdef.tpl' %} + {% endwith %} +{# end member definitions #} +</div> +{% endblock %} + |