summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>2015-08-30 09:58:05 (GMT)
committerDimitri van Heesch <dimitri@stack.nl>2015-08-30 09:58:05 (GMT)
commit4bd50c9f0dc1d7b1413a6bda587b8a5999cd7a19 (patch)
tree2a89f01904cc0bb7da2f36be73480d6b8d147953
parentabe254fbe2235f5b913653acd076d2acd579d5e1 (diff)
downloadDoxygen-4bd50c9f0dc1d7b1413a6bda587b8a5999cd7a19.zip
Doxygen-4bd50c9f0dc1d7b1413a6bda587b8a5999cd7a19.tar.gz
Doxygen-4bd50c9f0dc1d7b1413a6bda587b8a5999cd7a19.tar.bz2
Moved creation of inline class documentation to separate template file
-rw-r--r--src/context.cpp8
-rw-r--r--templates/html/htmlclass.tpl7
-rw-r--r--templates/html/htmlfile.tpl73
-rw-r--r--templates/html/htmlinlineclasses.tpl70
-rw-r--r--templates/html/htmlmodule.tpl73
-rw-r--r--templates/html/htmlnamespace.tpl73
6 files changed, 89 insertions, 215 deletions
diff --git a/src/context.cpp b/src/context.cpp
index 68e1167..8f9200e 100644
--- a/src/context.cpp
+++ b/src/context.cpp
@@ -1739,6 +1739,7 @@ class ClassContext::Private : public DefinitionContext<ClassContext::Private>
addProperty("allMembersFileName", this,&Private::allMembersFileName);
addProperty("memberGroups", this,&Private::memberGroups);
addProperty("additionalInheritedMembers",this,&Private::additionalInheritedMembers);
+ addProperty("isSimple", this,&Private::isSimple);
}
virtual ~Private() {}
TemplateVariant title() const
@@ -2362,6 +2363,10 @@ class ClassContext::Private : public DefinitionContext<ClassContext::Private>
}
return m_cache.additionalInheritedMembers.get();
}
+ TemplateVariant isSimple() const
+ {
+ return m_classDef->isSimple();
+ }
private:
ClassDef *m_classDef;
@@ -5192,7 +5197,8 @@ class ClassListContext::Private : public GenericNodeListContext
{
continue;
}
- if (cd->isLinkableInProject() && cd->templateMaster()==0)
+ if (cd->isLinkableInProject() && cd->templateMaster()==0 &&
+ !cd->isHidden() && !cd->isEmbeddedInOuterScope())
{
append(ClassContext::alloc(cd));
}
diff --git a/templates/html/htmlclass.tpl b/templates/html/htmlclass.tpl
index bb734b6..24694b3 100644
--- a/templates/html/htmlclass.tpl
+++ b/templates/html/htmlclass.tpl
@@ -180,7 +180,6 @@
</div>
{% endif %}
{# memberdecls #}
- {# TODO: isSimple #}
{# nestedClasses #}
{% with list=compound.classes label='nested-classes' title=tr.classes local=1 %}
{% include 'htmldeclcomp.tpl' %}
@@ -379,9 +378,9 @@
{% endif %}
{# member definitions #}
{# inline classes #}
- {% if compound.classes %}
- {# TODO write inlined simple classes: tr.classDocumentation / tr.typeDocumentation #}
- {% endif %}
+ {% with classList=compound.classes %}
+ {% include 'htmlinlineclasses.tpl' %}
+ {% endwith %}
{# typedefs #}
{% with memberListInfo=compound.detailedTypedefs %}
{% include 'htmlmemdef.tpl' %}
diff --git a/templates/html/htmlfile.tpl b/templates/html/htmlfile.tpl
index 67af096..dbf0841 100644
--- a/templates/html/htmlfile.tpl
+++ b/templates/html/htmlfile.tpl
@@ -160,76 +160,9 @@
{% 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&lt;
- {% for targ in targList %}
- {{ targ.type }}{% if targ.name %} {{ targ.name }}{% endif %}{% if targ.defVal %}&#160;= {{ targ.defVal }}{% endif %}{% if not forloop.last %}, {% endif %}
- {% endfor %}
- &gt;<br/>
- {% endfor %}
- {% endspaceless %}
- {{ class.classType }}&#160;{{ 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 %}
+ {% with classList=compound.inlineClasses %}
+ {% include 'htmlinlineclasses.tpl' %}
+ {% endwith %}
{# defines #}
{% with memberListInfo=compound.detailedMacros %}
{% include 'htmlmemdef.tpl' %}
diff --git a/templates/html/htmlinlineclasses.tpl b/templates/html/htmlinlineclasses.tpl
new file mode 100644
index 0000000..876c491
--- /dev/null
+++ b/templates/html/htmlinlineclasses.tpl
@@ -0,0 +1,70 @@
+{# input: classList #}
+{% if classList %}
+ <h2 class="groupheader">{{ tr.classDocumentation }}</h2>
+ {% for class in classList %}
+ {# 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">
+ {# template specifier #}
+ {% if class.language=='cpp' and class.templateDecls %}
+ <h3>{% spaceless %}
+ {% for targList in class.templateDecls %}
+ template&lt;
+ {% for targ in targList %}
+ {{ targ.type }}{% if targ.name %} {{ targ.name }}{% endif %}{% if targ.defVal %}&#160;= {{ targ.defVal }}{% endif %}{% if not forloop.last %}, {% endif %}
+ {% endfor %}
+ &gt;<br/>
+ {% endfor %}
+ {% endspaceless %}
+ {{ class.classType }}&#160;{{ 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 }}</th></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 %}
diff --git a/templates/html/htmlmodule.tpl b/templates/html/htmlmodule.tpl
index ff97b2c..887da1b 100644
--- a/templates/html/htmlmodule.tpl
+++ b/templates/html/htmlmodule.tpl
@@ -214,76 +214,9 @@
{% 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&lt;
- {% for targ in targList %}
- {{ targ.type }}{% if targ.name %} {{ targ.name }}{% endif %}{% if targ.defVal %}&#160;= {{ targ.defVal }}{% endif %}{% if not forloop.last %}, {% endif %}
- {% endfor %}
- &gt;<br/>
- {% endfor %}
- {% endspaceless %}
- {{ class.classType }}&#160;{{ 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 %}
+ {% with classList=compound.inlineClasses %}
+ {% include 'htmlinlineclasses.tpl' %}
+ {% endwith %}
{# defines #}
{% with memberListInfo=compound.detailedMacros %}
{% include 'htmlmemdef.tpl' %}
diff --git a/templates/html/htmlnamespace.tpl b/templates/html/htmlnamespace.tpl
index e21ba9d..eb127de 100644
--- a/templates/html/htmlnamespace.tpl
+++ b/templates/html/htmlnamespace.tpl
@@ -114,76 +114,9 @@
{% 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&lt;
- {% for targ in targList %}
- {{ targ.type }}{% if targ.name %} {{ targ.name }}{% endif %}{% if targ.defVal %}&#160;= {{ targ.defVal }}{% endif %}{% if not forloop.last %}, {% endif %}
- {% endfor %}
- &gt;<br/>
- {% endfor %}
- {% endspaceless %}
- {{ class.classType }}&#160;{{ 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 %}
+ {% with classList=compound.inlineClasses %}
+ {% include 'htmlinlineclasses.tpl' %}
+ {% endwith %}
{# typedefs #}
{% with memberListInfo=compound.detailedTypedefs %}
{% include 'htmlmemdef.tpl' %}