-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Moved creation of inline class documentation to separate template file
- Loading branch information
Dimitri van Heesch
committed
Aug 30, 2015
1 parent
abe254f
commit 4bd50c9
Showing
6 changed files
with
89 additions
and
215 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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< | ||
{% 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 }}</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 %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters