aboutsummaryrefslogtreecommitdiffstats
path: root/doc/docfx/default_efl/partials/class.header.tmpl.partial
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2019-01-30 19:20:43 +0100
committerXavi Artigas <xavierartigas@yahoo.es>2019-02-11 14:18:12 +0100
commit133b659b7301c2bf577491575a5e7f455b345347 (patch)
tree85f9eed5eac40bdcd095fdc36b98606f00cfd521 /doc/docfx/default_efl/partials/class.header.tmpl.partial
parentdocs: Update efl_object lifecycle docs (diff)
downloadefl-133b659b7301c2bf577491575a5e7f455b345347.tar.gz
docs: Add custom DocFX templates
Summary: These templates add the following features: - Collapsible sections for simpler reading - Full class names in ancestors list (Could not make it work for descendants) - Removed duplicated Implements section - Removed huge Inherited Members section - Extended maximum number of hierarchy levels from 5 to 10 (because our hierarchy is really that big) Test Plan: Follow the doc/docfx README to generate the HTML pages and enjoy the improved and slightly-more-usable docs. Reviewers: lauromoura, bu5hm4n, zmike, cedric Reviewed By: lauromoura Subscribers: #reviewers, #committers Tags: #efl Differential Revision: https://phab.enlightenment.org/D7832
Diffstat (limited to '')
-rw-r--r--doc/docfx/default_efl/partials/class.header.tmpl.partial98
1 files changed, 98 insertions, 0 deletions
diff --git a/doc/docfx/default_efl/partials/class.header.tmpl.partial b/doc/docfx/default_efl/partials/class.header.tmpl.partial
new file mode 100644
index 0000000000..1a445ab3ca
--- /dev/null
+++ b/doc/docfx/default_efl/partials/class.header.tmpl.partial
@@ -0,0 +1,98 @@
+{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}}
+
+<h1 id="{{id}}" data-uid="{{uid}}" class="text-break">{{>partials/title}}</h1>
+<div class="markdown level0 summary">{{{summary}}}</div>
+<div class="markdown level0 conceptual">{{{conceptual}}}</div>
+{{#inClass}}
+<div class="inheritance">
+ <h5><a href="#collapsible-inheritance" class="expander collapsed" data-toggle="collapse">{{__global.inheritance}}</a></h5>
+ <div id="collapsible-inheritance" class="collapse">
+ {{#inheritance}}
+ <div class="level{{index}}"><xref uid="{{uid}}" text="{{fullName.0.value}}"/></div>
+ {{/inheritance}}
+ <div class="level{{level}}"><span class="xref"><b>{{fullName.0.value}}</b></span></div>
+ {{#derivedClasses}}
+ <div class="level{{index}}">{{{specName.0.value}}}</div>
+ {{/derivedClasses}}
+ </div>
+</div>
+{{/inClass}}
+
+{{#inheritedMembers.0}}
+<h6><strong>{{__global.namespace}}</strong>: {{{namespace.specName.0.value}}}</h6>
+<h6><strong>{{__global.assembly}}</strong>: {{assemblies.0}}.dll</h6>
+<h5 id="{{id}}_syntax">{{__global.syntax}}</h5>
+<div class="codewrapper">
+ <pre><code class="lang-{{_lang}} hljs">{{syntax.content.0.value}}</code></pre>
+</div>
+{{#syntax.parameters.0}}
+<h5 class="parameters">{{__global.parameters}}</h5>
+<table class="table table-bordered table-striped table-condensed">
+ <thead>
+ <tr>
+ <th>{{__global.type}}</th>
+ <th>{{__global.name}}</th>
+ <th>{{__global.description}}</th>
+ </tr>
+ </thead>
+ <tbody>
+{{/syntax.parameters.0}}
+{{#syntax.parameters}}
+ <tr>
+ <td>{{{type.specName.0.value}}}</td>
+ <td><span class="parametername">{{{id}}}</span></td>
+ <td>{{{description}}}</td>
+ </tr>
+{{/syntax.parameters}}
+{{#syntax.parameters.0}}
+ </tbody>
+</table>
+{{/syntax.parameters.0}}
+{{#syntax.return}}
+<h5 class="returns">{{__global.returns}}</h5>
+<table class="table table-bordered table-striped table-condensed">
+ <thead>
+ <tr>
+ <th>{{__global.type}}</th>
+ <th>{{__global.description}}</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>{{{type.specName.0.value}}}</td>
+ <td>{{{description}}}</td>
+ </tr>
+ </tbody>
+</table>
+{{/syntax.return}}
+{{#syntax.typeParameters.0}}
+<h5 class="typeParameters">{{__global.typeParameters}}</h5>
+<table class="table table-bordered table-striped table-condensed">
+ <thead>
+ <tr>
+ <th>{{__global.name}}</th>
+ <th>{{__global.description}}</th>
+ </tr>
+ </thead>
+ <tbody>
+{{/syntax.typeParameters.0}}
+{{#syntax.typeParameters}}
+ <tr>
+ <td><span class="parametername">{{{id}}}</span></td>
+ <td>{{{description}}}</td>
+ </tr>
+{{/syntax.typeParameters}}
+{{#syntax.typeParameters.0}}
+ </tbody>
+</table>
+{{/syntax.typeParameters.0}}
+{{#remarks}}
+<h5 id="{{id}}_remarks"><strong>{{__global.remarks}}</strong></h5>
+<div class="markdown level0 remarks">{{{remarks}}}</div>
+{{/remarks}}
+{{#example.0}}
+<h5 id="{{id}}_examples"><strong>{{__global.examples}}</strong></h5>
+{{/example.0}}
+{{#example}}
+{{{.}}}
+{{/example}}