diff options
author | Dimitri van Heesch <dimitri@stack.nl> | 2015-09-08 14:10:32 (GMT) |
---|---|---|
committer | Dimitri van Heesch <dimitri@stack.nl> | 2015-09-08 14:10:32 (GMT) |
commit | e58fb0a46f73f37d16859f43fda1eb5ba4a15c5d (patch) | |
tree | e2c81dd42a25e439ea0055605418732883a173d0 /templates | |
parent | 5aa4ade86499ba615da48875a9e7292ddd22c22f (diff) | |
download | Doxygen-e58fb0a46f73f37d16859f43fda1eb5ba4a15c5d.zip Doxygen-e58fb0a46f73f37d16859f43fda1eb5ba4a15c5d.tar.gz Doxygen-e58fb0a46f73f37d16859f43fda1eb5ba4a15c5d.tar.bz2 |
Template enhancements and various other small fixes
Diffstat (limited to 'templates')
32 files changed, 194 insertions, 105 deletions
diff --git a/templates/html/htmlannotated.tpl b/templates/html/htmlannotated.tpl index dd72ac9..c5faa14 100644 --- a/templates/html/htmlannotated.tpl +++ b/templates/html/htmlannotated.tpl @@ -4,7 +4,7 @@ <div class="textblock"> {{ tr.classListDescription }} </div> -{% indexentry nav name=tr.classes file=page.fileName anchor='' %} +{% indexentry nav name=tr.classes file=page.fileName anchor='' isReference=False %} {% opensubindex nav %} {% with tree=classTree %} {% include 'htmldirtree.tpl' %} diff --git a/templates/html/htmlbase.tpl b/templates/html/htmlbase.tpl index 84807ec..aacaf92 100644 --- a/templates/html/htmlbase.tpl +++ b/templates/html/htmlbase.tpl @@ -192,6 +192,15 @@ $(document).ready(function(){initNavTree('{{ page.fileName }}{% if page_postfix <div id="nav-path" class="navpath">{# id is needed for treeview function! #} <ul> {# navpath #} + {% if page|get:'navigationPath' %} + {% for obj in page.navigationPath %} + <li class="navelem"> + {% with text=obj.text %} + {% include 'htmlobjlink.tpl' %} + {% endwith %} + </li> + {% endfor %} + {% endif %} <li class="footer"> {% if config.HTML_TIMESTAMP %} {{ tr.generatedAt:doxygen.date,config.PROJECT_NAME }} diff --git a/templates/html/htmlclass.tpl b/templates/html/htmlclass.tpl index 24694b3..9a2b494 100644 --- a/templates/html/htmlclass.tpl +++ b/templates/html/htmlclass.tpl @@ -2,9 +2,11 @@ {% msg %}Generating HTML output for class {{ compound.name }}{% endmsg %} {% block navpath %} -{% with navpath=compound.navigationPath %} - {% include 'htmlnavpath.tpl' %} -{% endwith %} +{% if not config.GENERATE_TREEVIEW %} + {% with navpath=compound.navigationPath %} + {% include 'htmlnavpath.tpl' %} + {% endwith %} +{% endif %} {% endblock %} {% block title %} @@ -378,7 +380,7 @@ {% endif %} {# member definitions #} {# inline classes #} - {% with classList=compound.classes %} + {% with classList=compound.innerClasses %} {% include 'htmlinlineclasses.tpl' %} {% endwith %} {# typedefs #} diff --git a/templates/html/htmlclasses.tpl b/templates/html/htmlclasses.tpl index 8a1bf18..c00ce32 100644 --- a/templates/html/htmlclasses.tpl +++ b/templates/html/htmlclasses.tpl @@ -2,7 +2,7 @@ {% block content %} <div class="contents"> <div class="textblock"> -{% indexentry nav name=tr.classIndex file=page.fileName anchor='' %} +{% indexentry nav name=tr.classIndex file=page.fileName anchor='' isReference=False %} </div> {% with index=classIndex.list|alphaIndex:'name' %} {# quick index at top #} diff --git a/templates/html/htmldeclcomp.tpl b/templates/html/htmldeclcomp.tpl index 4bd99d2..3ae90b8 100644 --- a/templates/html/htmldeclcomp.tpl +++ b/templates/html/htmldeclcomp.tpl @@ -21,7 +21,6 @@ <tr class="memdesc:{{ nc.anchor }}"><td class="mdescLeft"> </td><td class="mdescRight"> {{ nc.brief }} {% if nc.hasDetails %} - {# TODO: link to group if member is grouped #} <a href="{{ page.relPath }}{{ nc.fileName }}{{ config.HTML_FILE_EXTENSION}}{% if nc.anchor %}#{{ nc.anchor }}{% endif %}">{{ tr.more }}</a> {% endif %} <br/></td></tr> diff --git a/templates/html/htmldir.tpl b/templates/html/htmldir.tpl index a399759..aeb2fa5 100644 --- a/templates/html/htmldir.tpl +++ b/templates/html/htmldir.tpl @@ -2,18 +2,10 @@ {% msg %}Generating HTML output for directory {{ compound.name }}{% endmsg %} {% block navpath %} - {% if compound.navigationPath %} - <div id="nav-path" class="navpath"> - <ul> - {% for obj in compound.navigationPath %} - <li class="navelem"> - {% with text=obj.text %} - {% include 'htmlobjlink.tpl' %} - {% endwith %} - </li> - {% endfor %} - </ul> - </div> + {% if not config.GENERATE_TREEVIEW %} + {% with navpath=compound.navigationPath %} + {% include 'htmlnavpath.tpl' %} + {% endwith %} {% endif %} {% endblock %} diff --git a/templates/html/htmldirtree.tpl b/templates/html/htmldirtree.tpl index 2fa266a..a6b9b21 100644 --- a/templates/html/htmldirtree.tpl +++ b/templates/html/htmldirtree.tpl @@ -11,7 +11,7 @@ {# the table with entries #} <table class="directory"> {% recursetree tree.tree %} - {% indexentry nav name=node.name file=node.fileName anchor=node.anchor %} + {% indexentry nav name=node.name file=node.fileName anchor=node.anchor isReference=node.isReference externalReference=node.externalReference %} {% spaceless %} <tr id="row_{{ node.id }}" class="{% cycle 'even' 'odd' %}"{%if node.level>tree.preferredDepth %} style="display:none;"{% endif %}> <td class="entry"> @@ -30,7 +30,13 @@ {% elif node.dir %} <span id="img_{{ node.id }}" class="iconf{%if node.level+1<tree.preferredDepth %}open{% else %}closed{% endif %}" onclick="toggleFolder('{{ node.id }}')"> </span> {% elif node.file %} + {% if node.file.hasSourceFile %} + <a href="{{ node.file.sourceFileName }}{{ config.HTML_FILE_EXTENSION }}"> + {% endif %} <span class="icondoc"></span> + {% if node.file.hasSourceFile %} + </a> + {% endif %} {% endif %} {% with obj=node text=node.name %} {% include 'htmlobjlink.tpl' %} diff --git a/templates/html/htmlexample.tpl b/templates/html/htmlexample.tpl new file mode 100644 index 0000000..f8c1f96 --- /dev/null +++ b/templates/html/htmlexample.tpl @@ -0,0 +1,17 @@ +{% extend 'htmlbase.tpl' %} +{% msg %}Generating HTML output for example {{ compound.name }}{% endmsg %} + +{% block navpath %} + {% if not config.GENERATE_TREEVIEW %} + {% with navpath=compound.navigationPath %} + {% include 'htmlnavpath.tpl' %} + {% endwith %} + {% endif %} +{% endblock %} + +{% block content %} +<div class="contents"> +{{ compound.details }} +{{ compound.example }} +</div> +{% endblock %} diff --git a/templates/html/htmlexamples.tpl b/templates/html/htmlexamples.tpl new file mode 100644 index 0000000..58392df --- /dev/null +++ b/templates/html/htmlexamples.tpl @@ -0,0 +1,15 @@ +{% extend 'htmlbase.tpl' %} +{% block content %} +<div class="contents"> +<div class="textblock"> +{{ tr.examplesDescription }} +</div> +{% indexentry nav name=tr.examples file=page.fileName anchor='' isReference=False %} +{% opensubindex nav %} +{% with tree=exampleTree %} + {% include 'htmldirtree.tpl' %} +{% endwith %} +{% closesubindex nav %} +</div><!-- contents --> +{% endblock %} + diff --git a/templates/html/htmlfile.tpl b/templates/html/htmlfile.tpl index dbf0841..80e2826 100644 --- a/templates/html/htmlfile.tpl +++ b/templates/html/htmlfile.tpl @@ -2,9 +2,11 @@ {% msg %}Generating HTML output for file {{ compound.name }}{% endmsg %} {% block navpath %} -{% with navpath=compound.navigationPath %} - {% include 'htmlnavpath.tpl' %} -{% endwith %} + {% if not config.GENERATE_TREEVIEW %} + {% with navpath=compound.navigationPath %} + {% include 'htmlnavpath.tpl' %} + {% endwith %} + {% endif %} {% endblock %} {% block title %} diff --git a/templates/html/htmlfiles.tpl b/templates/html/htmlfiles.tpl index 1871d4d..55799ca 100644 --- a/templates/html/htmlfiles.tpl +++ b/templates/html/htmlfiles.tpl @@ -4,7 +4,7 @@ <div class="textblock"> {{ tr.fileListDescription }} </div> -{% indexentry nav name=tr.fileList file=page.fileName anchor='' %} +{% indexentry nav name=tr.fileList file=page.fileName anchor='' isReference=False %} {% opensubindex nav %} {% with tree=fileTree %} {% include 'htmldirtree.tpl' %} diff --git a/templates/html/htmlhierarchy.tpl b/templates/html/htmlhierarchy.tpl index 5d03755..ff10172 100644 --- a/templates/html/htmlhierarchy.tpl +++ b/templates/html/htmlhierarchy.tpl @@ -7,7 +7,7 @@ <p><a href="inherits{{ config.HTML_FILE_EXTENSION }}">{{ tr.gotoGraphicalHierarchy }}</a></p> {% endif %} </div> -{% indexentry nav name=tr.classHierarchy file=page.fileName anchor='' %} +{% indexentry nav name=tr.classHierarchy file=page.fileName anchor='' isReference=False %} {% opensubindex nav %} {% with tree=classHierarchy %} {% include 'htmldirtree.tpl' %} diff --git a/templates/html/htmlindexpages.tpl b/templates/html/htmlindexpages.tpl index 65bf1b6..2886a69 100644 --- a/templates/html/htmlindexpages.tpl +++ b/templates/html/htmlindexpages.tpl @@ -9,7 +9,7 @@ {% for sect in index %} {% with letter=sect.letter %} {% set page_postfix=section|append:'_'|append:sect.label %} - {% indexentry nav name=letter file=page.fileName|append:page_postfix anchor='' %} + {% indexentry nav name=letter file=page.fileName|append:page_postfix anchor='' isReference=False %} {# create index pages for all globals starting with a specific letter #} {% create page.fileName|append:page_postfix|append:config.HTML_FILE_EXTENSION from template %} {% endwith %} diff --git a/templates/html/htmljsnavtree.tpl b/templates/html/htmljsnavtree.tpl index 99a269e..9970161 100644 --- a/templates/html/htmljsnavtree.tpl +++ b/templates/html/htmljsnavtree.tpl @@ -1,7 +1,7 @@ var NAVTREE = [ {% recursetree index.nav %} - [ "{{ node.name }}", {% if node.file %}"{{ node.file }}{{ config.HTML_FILE_EXTENSION }}{% if node.anchor %}#{{ node.anchor }}{% endif %}"{% else %}null{% endif %},{% if not node.is_leaf_node %} [ + [ "{{ node.name }}", {% if node.file %}"{% if node.isReference %}{{ node.externalReference }}{% endif %}{{ node.file }}{{ config.HTML_FILE_EXTENSION }}{% if node.anchor %}#{{ node.anchor }}{% endif %}"{% else %}null{% endif %},{% if not node.is_leaf_node %} [ {{ children }} ]{% else %} null{% endif %} ]{% if not node.last %},{% endif %} {% endrecursetree %} diff --git a/templates/html/htmllayout.tpl b/templates/html/htmllayout.tpl index c21ef91..52883a3 100644 --- a/templates/html/htmllayout.tpl +++ b/templates/html/htmllayout.tpl @@ -62,14 +62,14 @@ {# -------------------------------------------------- #} {# global constants #} -{% set maxItemsForFlatList=2 %} -{% set maxItemsForMultiPageList=4 %} +{% set maxItemsForFlatList=30 %} +{% set maxItemsForMultiPageList=200 %} {# global variable #} {% set page_postfix='' %} {# open the global navigation index #} -{% indexentry nav name=tr.mainPage file='index' anchor='' %} +{% indexentry nav name=tr.mainPage file='index' anchor='' isReference=False %} {% opensubindex nav %} {# ----------- HTML DOCUMENTATION PAGES ------------ #} @@ -100,7 +100,6 @@ {% for compound in fileList %} {% with page=compound %} {# TODO: to deal with clang optimisation, we need to write the sources in a different order! #} - {# TODO: now writing sources has the side-effect of creating cross-references. Need to split that up! #} {% if compound.hasSourceFile %} {% create compound.sourceFileName|append:config.HTML_FILE_EXTENSION from 'htmlsource.tpl' %} {% endif %} @@ -128,7 +127,12 @@ {% endwith %} {% endfor %} -{# TODO: write example documentation #} +{# write example documentation #} +{% for compound in exampleList %} + {% with page=compound %} + {% create compound.fileName|append:config.HTML_FILE_EXTENSION from 'htmlexample.tpl' %} + {% endwith %} +{% endfor %} {# ----------- INDEXES ------------ #} @@ -139,6 +143,13 @@ {% endwith %} {% endif %} +{# ---- examples --- #} +{% if exampleTree.tree %} + {% with page=exampleTree %} + {% create exampleTree.fileName|append:config.HTML_FILE_EXTENSION from 'htmlexamples.tpl' %} + {% endwith %} +{% endif %} + {# --- modules --- #} {% if moduleTree.tree %} {% with page=moduleTree %} @@ -147,8 +158,9 @@ {% endif %} {# --- namespaces --- #} -{% indexentry nav name=tr.namespaces file='' anchor='' %} -{% opensubindex nav %} +{% if namespaceList %} + {% indexentry nav name=tr.namespaces file='' anchor='' isReference=False %} + {% opensubindex nav %} {% if namespaceTree.tree %} {% with page=namespaceTree %} @@ -159,16 +171,18 @@ {# write symbol indices for namespace members #} {% if namespaceMembersIndex.all %} {% with page=namespaceMembersIndex scope='namespace' template='htmlnsmembers.tpl' %} - {% indexentry nav name=tr.namespaceMembers file=page.fileName anchor='' %} + {% indexentry nav name=tr.namespaceMembers file=page.fileName anchor='' isReference=False %} {% include 'htmlmembersindex.tpl' %} {% endwith %} {% endif %} -{% closesubindex nav %} + {% closesubindex nav %} +{% endif %} {# --- classes --- #} -{% indexentry nav name=tr.classes file='' anchor='' %} -{% opensubindex nav %} +{% if classList %} + {% indexentry nav name=tr.classes file='' anchor='' isReference=False %} + {% opensubindex nav %} {# write the annotated class list #} {% if classTree.tree %} @@ -184,12 +198,10 @@ {% endwith %} {% endif %} - {# TODO: write the class inheritance hierarchy #} + {# write the class inheritance hierarchy #} {% if classHierarchy.tree %} {% with page=classHierarchy %} {% create classHierarchy.fileName|append:config.HTML_FILE_EXTENSION from 'htmlhierarchy.tpl' %} - {% endwith %} - {% with page=classHierarchy %} {% if config.HAVE_DOT and config.GRAPHICAL_HIERARCHY %} {% with fileName='inherits' %} {% create fileName|append:config.HTML_FILE_EXTENSION from 'htmlgraphhierarchy.tpl' %} @@ -201,16 +213,18 @@ {# write symbol indices for class members #} {% if classMembersIndex.all %} {% with page=classMembersIndex scope='class' template='htmlclmembers.tpl' %} - {% indexentry nav name=tr.classMembers file=page.fileName anchor='' %} + {% indexentry nav name=tr.classMembers file=page.fileName anchor='' isReference=False %} {% include 'htmlmembersindex.tpl' %} {% endwith %} {% endif %} -{% closesubindex nav %} + {% closesubindex nav %} +{% endif %} {# --- files --- #} -{% indexentry nav name=tr.files file='' anchor='' %} -{% opensubindex nav %} +{% if fileList %} + {% indexentry nav name=tr.files file='' anchor='' isReference=False %} + {% opensubindex nav %} {# write the directory/file hierarchy #} {% if fileTree.tree %} @@ -222,12 +236,13 @@ {# write symbol indices for global namespace #} {% if globalsIndex.all %} {% with page=globalsIndex scope='file' template='htmlflmembers.tpl' %} - {% indexentry nav name=tr.fileMembers file=page.fileName anchor='' %} + {% indexentry nav name=tr.fileMembers file=page.fileName anchor='' isReference=False %} {% include 'htmlmembersindex.tpl' %} {% endwith %} {% endif %} -{% closesubindex nav %} + {% closesubindex nav %} +{% endif %} {# write directory documentation pages #} {% for compound in dirList %} diff --git a/templates/html/htmlmembersindex.tpl b/templates/html/htmlmembersindex.tpl index ef891df..700bce2 100644 --- a/templates/html/htmlmembersindex.tpl +++ b/templates/html/htmlmembersindex.tpl @@ -2,13 +2,13 @@ {% opensubindex nav %} {# all members #} {% with list=page.all section='' %} - {% indexentry nav name=tr.all file=page.fileName|append:page_postfix anchor='' %} + {% indexentry nav name=tr.all file=page.fileName|append:page_postfix anchor='' isReference=False %} {% include 'htmlindexpages.tpl' %} {% endwith %} {# functions #} {% if page.functions %} {% set page_postfix='_func' %} - {% indexentry nav name=tr.functions file=page.fileName|append:page_postfix anchor='' %} + {% indexentry nav name=tr.functions file=page.fileName|append:page_postfix anchor='' isReference=False %} {% with list=page.functions section=page_postfix %} {% include 'htmlindexpages.tpl' %} {% endwith %} @@ -16,7 +16,7 @@ {# variables #} {% if page.variables %} {% set page_postfix='_vars' %} - {% indexentry nav name=tr.variables file=page.fileName|append:page_postfix anchor='' %} + {% indexentry nav name=tr.variables file=page.fileName|append:page_postfix anchor='' isReference=False %} {% with list=page.variables section=page_postfix %} {% include 'htmlindexpages.tpl' %} {% endwith %} @@ -24,7 +24,7 @@ {# typedefs #} {% if page.typedefs %} {% set page_postfix='_type' %} - {% indexentry nav name=tr.typedefs file=page.fileName|append:page_postfix anchor='' %} + {% indexentry nav name=tr.typedefs file=page.fileName|append:page_postfix anchor='' isReference=False %} {% with list=page.typedefs section=page_postfix %} {% include 'htmlindexpages.tpl' %} {% endwith %} @@ -32,7 +32,7 @@ {# enums #} {% if page.enums %} {% set page_postfix='_enum' %} - {% indexentry nav name=tr.enums file=page.fileName|append:page_postfix anchor='' %} + {% indexentry nav name=tr.enums file=page.fileName|append:page_postfix anchor='' isReference=False %} {% with list=page.enums section=page_postfix %} {% include 'htmlindexpages.tpl' %} {% endwith %} @@ -40,7 +40,7 @@ {# enumValues #} {% if page.enumValues %} {% set page_postfix='_eval' %} - {% indexentry nav name=tr.enumValues file=page.fileName|append:page_postfix anchor='' %} + {% indexentry nav name=tr.enumValues file=page.fileName|append:page_postfix anchor='' isReference=False %} {% with list=page.enumValues section=page_postfix %} {% include 'htmlindexpages.tpl' %} {% endwith %} @@ -48,7 +48,7 @@ {# macros #} {% if page.macros %} {% set page_postfix='_defs' %} - {% indexentry nav name=tr.macros file=page.fileName|append:page_postfix anchor='' %} + {% indexentry nav name=tr.macros file=page.fileName|append:page_postfix anchor='' isReference=False %} {% with list=page.macros section=page_postfix %} {% include 'htmlindexpages.tpl' %} {% endwith %} @@ -56,7 +56,7 @@ {# properties #} {% if page.properties %} {% set page_postfix='_prop' %} - {% indexentry nav name=tr.properties file=page.fileName|append:page_postfix anchor='' %} + {% indexentry nav name=tr.properties file=page.fileName|append:page_postfix anchor='' isReference=False %} {% with list=page.properties section=page_postfix %} {% include 'htmlindexpages.tpl' %} {% endwith %} @@ -64,7 +64,7 @@ {# events #} {% if page.events %} {% set page_postfix='_evnt' %} - {% indexentry nav name=tr.events file=page.fileName|append:page_postfix anchor='' %} + {% indexentry nav name=tr.events file=page.fileName|append:page_postfix anchor='' isReference=False %} {% with list=page.events section=page_postfix %} {% include 'htmlindexpages.tpl' %} {% endwith %} @@ -72,7 +72,7 @@ {# related #} {% if page.related %} {% set page_postfix='_rela' %} - {% indexentry nav name=tr.related file=page.fileName|append:page_postfix anchor='' %} + {% indexentry nav name=tr.related file=page.fileName|append:page_postfix anchor='' isReference=False %} {% with list=page.related section=page_postfix %} {% include 'htmlindexpages.tpl' %} {% endwith %} diff --git a/templates/html/htmlmemdecl.tpl b/templates/html/htmlmemdecl.tpl index 6af75ce..c7894d8 100644 --- a/templates/html/htmlmemdecl.tpl +++ b/templates/html/htmlmemdecl.tpl @@ -17,7 +17,7 @@ enum </td><td class="memTemplItemRight" valign="bottom"> {# write name #} {% if not member.isAnonymous %} - {% with obj=member text=member.name %} + {% with obj=member text=member.nameWithContextFor:compound.compoundKind %} {% include 'htmlobjlink.tpl' %} {% endwith %} {% endif %} @@ -74,7 +74,7 @@ {% with ctx=member.anonymousType anonymousNestingLevel=anonymousNestingLevel|add:1 %} {{ ctx.compoundType }} {% if ctx.bareName %} -  <b>{{ ctx.bareName }}</b> {# TODO: associated documentation is lost! #} +  <b>{{ ctx.bareName }}</b> {% endif %} {</td></tr> {# recursively write members that can appear inside the anonymous class/struct #} @@ -128,11 +128,7 @@ <td class="memItemLeft" valign="top">{% repeat anonymousNestingLevel %}   {% endrepeat %} } {% else %} - {% if member.isObjCMethod %} - {% if member.isStatic %}+ {% else %}- {% endif %} - {% else %} - {{ member.declType }} - {% endif %} + {{ member.declType }} {% endif %} {% spaceless %}   @@ -140,16 +136,19 @@    {% else %} </td><td class="{% if member.templateArgs %}memTemplItemRight{% else %}memItemRight{% endif %}" valign="bottom"> + {% if member.isObjCMethod %} + {% if member.isStatic %}+ {% else %}- {% endif %} + {% endif %} {% endif %} {% endspaceless %} {# write name #} {% if not member.isAnonymous %} {% if member.anonymousMember %} - {% with obj=member.anonymousMember text=member.anonymousMember.name %} + {% with obj=member.anonymousMember text=member.anonymousMember.nameWithContextFor:compound.compoundKind %} {% include 'htmlobjlink.tpl' %} {% endwith %} {% else %} - {% with obj=member text=member.name %} + {% with obj=member text=member.nameWithContextFor:compound.compoundKind %} {% include 'htmlobjlink.tpl' %} {% endwith %} {% endif %} @@ -205,8 +204,7 @@ <tr class="memdesc:{{ member.anchor }}{% if inheritId %} inherit {{ inheritId }}{% endif %}"><td class="mdescLeft"> </td><td class="mdescRight"> {{ member.brief }} {% if member.hasDetails %} - {# TODO: link to group if member is grouped #} - <a href="#{{ member.anchor }}">{{ tr.more }}</a> + <a href="{{ member.fileName }}{{ config.HTML_FILE_EXTENSION }}#{{ member.anchor }}">{{ tr.more }}</a> {% endif %} <br/></td></tr> {% endif %} diff --git a/templates/html/htmlmemdef.tpl b/templates/html/htmlmemdef.tpl index be4d94e..2b03a22 100644 --- a/templates/html/htmlmemdef.tpl +++ b/templates/html/htmlmemdef.tpl @@ -3,9 +3,8 @@ {% if memberListInfo.members %} <h2 class="groupheader">{{ memberListInfo.title }}</h2> {% for member in memberListInfo.members %} - {% if member.hasDetails %} {# TODO: not the same as isDetailedSectionVisible! #} - {# TODO: handle enum + anonymous members #} - <a class="anchor" id="{{ member.anchor }}"></a> {# TODO: for namespace members written in a file we need to prepend file_ #} + {% if member.detailsVisibleFor:compound.compoundKind %} + <a class="anchor" id="{{ member.anchor }}"></a> <div class="memitem"> <div class="memproto"> {# write template declarations #} @@ -120,7 +119,22 @@ {% endif %} </div> <div class="memdoc"> - {# TODO: write group include #} + {# write group include #} + {% if compound.compoundKind=="module" and config.SHOW_GROUPED_MEMB_INC and member.file %} + <p><tt>{% spaceless %} + {% if compound.language=='java' or compound.language=='idl' %} + import  " + {% else %} + #include < + {% endif %} + {% with obj=member.file text=member.file.bareName %} + {% include 'htmlobjlink.tpl' %} + {% endwith %} + {% if compound.language=='java' or compound.language=='idl' %}" + {% else %}> + {% endif %} + {% endspaceless %}</tt></p> + {% endif %} {# multi-line initializer #} {% if member.hasMultiLineInitializer %} <b>{% if member.isDefine %}{{ tr.defineValue }}{% else %}{{ tr.initialValue }}{% endif %}</b> @@ -187,9 +201,25 @@ </p> {% endif %} {# category relation #} - - {# TODO #} - + {% if member.class and member.categoryRelation %} + {% if member.category %} + <p> + {% markers mem in member.categoryRelation|list with tr.providedByCategory %} + {% with obj=mem text=member.category.name %} + {% include 'htmlobjlink.tpl' %} + {% endwith %} + {% endmarkers %} + </p> + {% elif member.class.categoryOf %} + <p> + {% markers mem in member.categoryRelation|list with tr.extendsClass %} + {% with obj=mem text=member.class.categoryOf.name %} + {% include 'htmlobjlink.tpl' %} + {% endwith %} + {% endmarkers %} + </p> + {% endif %} + {% endif %} {# examples #} {% if member.examples %} <dl><dt><b>{{ tr.examples }}</b><dd> @@ -280,7 +310,6 @@ </div> {% endif %} {% endfor %} {# for each member #} - {# TODO: write member group docs #} {% endif %} {% endif %} diff --git a/templates/html/htmlmodule.tpl b/templates/html/htmlmodule.tpl index 887da1b..ce80514 100644 --- a/templates/html/htmlmodule.tpl +++ b/templates/html/htmlmodule.tpl @@ -2,9 +2,11 @@ {% msg %}Generating HTML output for module {{ compound.name }}{% endmsg %} {% block navpath %} -{% with navpath=compound.navigationPath %} - {% include 'htmlnavpath.tpl' %} -{% endwith %} + {% if not config.GENERATE_TREEVIEW %} + {% with navpath=compound.navigationPath %} + {% include 'htmlnavpath.tpl' %} + {% endwith %} + {% endif %} {% endblock %} {% block title %} diff --git a/templates/html/htmlmodules.tpl b/templates/html/htmlmodules.tpl index f19c225..5431032 100644 --- a/templates/html/htmlmodules.tpl +++ b/templates/html/htmlmodules.tpl @@ -4,7 +4,7 @@ <div class="textblock"> {{ tr.modulesDescription }} </div> -{% indexentry nav name=tr.modules file=page.fileName anchor='' %} +{% indexentry nav name=tr.modules file=page.fileName anchor='' isReference=False %} {% opensubindex nav %} {% with tree=moduleTree %} {% include 'htmldirtree.tpl' %} diff --git a/templates/html/htmlnamespace.tpl b/templates/html/htmlnamespace.tpl index eb127de..d359efa 100644 --- a/templates/html/htmlnamespace.tpl +++ b/templates/html/htmlnamespace.tpl @@ -2,9 +2,11 @@ {% msg %}Generating HTML output for namespace {{ compound.name }}{% endmsg %} {% block navpath %} -{% with navpath=compound.navigationPath %} - {% include 'htmlnavpath.tpl' %} -{% endwith %} +{% if not config.GENERATE_TREEVIEW %} + {% with navpath=compound.navigationPath %} + {% include 'htmlnavpath.tpl' %} + {% endwith %} +{% endif %} {% endblock %} {% block title %} diff --git a/templates/html/htmlnamespaces.tpl b/templates/html/htmlnamespaces.tpl index 4767d13..b7e7b9d 100644 --- a/templates/html/htmlnamespaces.tpl +++ b/templates/html/htmlnamespaces.tpl @@ -4,7 +4,7 @@ <div class="textblock"> {{ tr.namespaceListDescription }} </div> -{% indexentry nav name=tr.namespaceList file=page.fileName anchor='' %} +{% indexentry nav name=tr.namespaceList file=page.fileName anchor='' isReference=False %} {% opensubindex nav %} {% with tree=namespaceTree %} {% include 'htmldirtree.tpl' %} diff --git a/templates/html/htmlnavtree.tpl b/templates/html/htmlnavtree.tpl index 8da89a2..9713232 100644 --- a/templates/html/htmlnavtree.tpl +++ b/templates/html/htmlnavtree.tpl @@ -17,6 +17,6 @@ var NAVTREEINDEX = {# write all sub indices #} {% for entries in navTree.subindices %} {% with idx=forloop.counter0 %} - {% create idx|prepend:'navtreeindex'|append:'.js' from htmlnavindex.tpl' %} + {% create idx|prepend:'navtreeindex'|append:'.js' from 'htmlnavindex.tpl' %} {% endwith %} {% endfor %} diff --git a/templates/html/htmlobjlink.tpl b/templates/html/htmlobjlink.tpl index 51a281f..5d3c3f4 100644 --- a/templates/html/htmlobjlink.tpl +++ b/templates/html/htmlobjlink.tpl @@ -1,6 +1,10 @@ -{# inputs: obj (with .isLinkable .anchor .fileName), text, config, page.relPath #} +{# inputs: obj (with .isLinkable .isReference .anchor .fileName .externalReference), text, config, page.relPath #} {% if obj.isLinkable %} +{% if obj.isReference %} +<a class="elRef" href="{{ obj.externalReference }}{{ obj.fileName }}{{ config.HTML_FILE_EXTENSION }}{% if obj.anchor %}#{{ obj.anchor }}{% endif %}">{{ text }}</a> +{% else %} <a class="el" href="{{ page.relPath }}{{ obj.fileName }}{{ config.HTML_FILE_EXTENSION }}{% if obj.anchor %}#{{ obj.anchor }}{% endif %}">{{ text }}</a> +{% endif %} {% else %} <b>{{ text }}</b> {% endif %} diff --git a/templates/html/htmlpage.tpl b/templates/html/htmlpage.tpl index 3882989..7547ed5 100644 --- a/templates/html/htmlpage.tpl +++ b/templates/html/htmlpage.tpl @@ -2,9 +2,11 @@ {% msg %}Generating HTML output for page {{ compound.name }}{% endmsg %} {% block navpath %} -{% with navpath=compound.navigationPath %} - {% include 'htmlnavpath.tpl' %} -{% endwith %} + {% if not config.GENERATE_TREEVIEW %} + {% with navpath=compound.navigationPath %} + {% include 'htmlnavpath.tpl' %} + {% endwith %} + {% endif %} {% endblock %} {% block content %} diff --git a/templates/html/htmlpages.tpl b/templates/html/htmlpages.tpl index cc00bf5..5e3778d 100644 --- a/templates/html/htmlpages.tpl +++ b/templates/html/htmlpages.tpl @@ -4,7 +4,7 @@ <div class="textblock"> {{ tr.relatedPagesDesc }} </div> -{% indexentry nav name=tr.pages file=page.fileName anchor='' %} +{% indexentry nav name=tr.pages file=page.fileName anchor='' isReference=False %} {% opensubindex nav %} {% with tree=pageTree %} {% include 'htmldirtree.tpl' %} diff --git a/templates/html/htmlsource.tpl b/templates/html/htmlsource.tpl index cb4e65d..dda2b8c 100644 --- a/templates/html/htmlsource.tpl +++ b/templates/html/htmlsource.tpl @@ -2,18 +2,10 @@ {% msg %}Generating HTML source code for file {{ compound.name }}{% endmsg %} {% block navpath %} - {% if compound.navigationPath %} - <div id="nav-path" class="navpath"> - <ul> - {% for obj in compound.navigationPath %} - <li class="navelem"> - {% with text=obj.text %} - {% include 'htmlobjlink.tpl' %} - {% endwith %} - </li> - {% endfor %} - </ul> - </div> + {% if not config.GENERATE_TREEVIEW %} + {% with navpath=compound.navigationPath %} + {% include 'htmlnavpath.tpl %} + {% endwith %} {% endif %} {% endblock %} diff --git a/templates/html/htmltabs.tpl b/templates/html/htmltabs.tpl index 4c48f54..e7539d9 100644 --- a/templates/html/htmltabs.tpl +++ b/templates/html/htmltabs.tpl @@ -24,7 +24,7 @@ <li{% if page.highlight=='files' %} class="current"{% endif %}><a href="{{ page.relPath }}files{{ config.HTML_FILE_EXTENSION }}"><span>{{ tr.files|nowrap }}</span></a></li> {% endif %} {# examples tab #} - {% if exampleList.items %} + {% if exampleTree.tree %} <li{% if page.highlight=='examples' %} class="current"{% endif %}><a href="{{ page.relPath }}examples{{ config.HTML_FILE_EXTENSION }}"><span>{{ tr.examples|nowrap }}</span></a></li> {% endif %} {# search box #} diff --git a/templates/latex/latexclass.tpl b/templates/latex/latexclass.tpl index 7671de0..9fdcb24 100644 --- a/templates/latex/latexclass.tpl +++ b/templates/latex/latexclass.tpl @@ -93,7 +93,7 @@ <% if compound.examples %> <dl><dt><b><{ tr.examples }></b><dd> <% markers obj in compound.examples with tr.exampleList:compound.examples|length %> - <% with text=obj.text %> + <% with page=compound text=obj.text %> <% include 'htmlobjlink.tpl' %> <% endwith %> <% endmarkers %> @@ -102,7 +102,7 @@ <# source definition #> <% if compound.sourceDef %> <% markers obj in compound.sourceDef with tr.definedAtLineInSourceFile %> - <% with text=obj.text %> + <% with page=compound text=obj.text %> <% include 'htmlobjlink.tpl' %> <% endwith %> <% endmarkers %> diff --git a/templates/latex/latexfiles.tpl b/templates/latex/latexfiles.tpl index e69de29..a9a897d 100644 --- a/templates/latex/latexfiles.tpl +++ b/templates/latex/latexfiles.tpl @@ -0,0 +1 @@ +<# TODO #> diff --git a/templates/latex/latexmodules.tpl b/templates/latex/latexmodules.tpl index e69de29..a9a897d 100644 --- a/templates/latex/latexmodules.tpl +++ b/templates/latex/latexmodules.tpl @@ -0,0 +1 @@ +<# TODO #> diff --git a/templates/latex/latexnamespaces.tpl b/templates/latex/latexnamespaces.tpl index e69de29..a9a897d 100644 --- a/templates/latex/latexnamespaces.tpl +++ b/templates/latex/latexnamespaces.tpl @@ -0,0 +1 @@ +<# TODO #> |