mirror of
https://github.com/eclipse/upm.git
synced 2025-07-03 18:31:13 +03:00
jsdoc: generate modules for sensor groups; customize yuidoc templates for displaying sensor groups by categories & connection types
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Heidi Pan
committed by
Mihai Tudor Panu
Mihai Tudor Panu
parent
ed52f0e5cb
commit
33b508110e
205
doxy/node/generators/yuidoc/tmpl/partials/classes.handlebars
Normal file
205
doxy/node/generators/yuidoc/tmpl/partials/classes.handlebars
Normal file
@ -0,0 +1,205 @@
|
||||
<h1>{{name}} Class</h1>
|
||||
<div class="box meta">
|
||||
{{#if uses}}
|
||||
<div class="uses">
|
||||
Uses
|
||||
<ul class="inline commas">
|
||||
{{#uses}}
|
||||
<li><a href="{{.}}.html">{{.}}</a></li>
|
||||
{{/uses}}
|
||||
</ul>
|
||||
</div>
|
||||
{{/if}}
|
||||
|
||||
{{#if extends}}
|
||||
<div class="extends">
|
||||
Extends {{#crossLink extends}}{{/crossLink}}
|
||||
</div>
|
||||
{{/if}}
|
||||
|
||||
{{#if foundAt}}
|
||||
<div class="foundat">
|
||||
Defined in: <a href="{{foundAt}}">`{{{file}}}:{{{line}}}`</a>
|
||||
</div>
|
||||
{{/if}}
|
||||
|
||||
{{#if module}}
|
||||
{{#if submodule}}
|
||||
Module: {{#crossLinkModule submodule}}{{/crossLinkModule}}<br>
|
||||
Parent Module: {{#crossLinkModule module}}{{/crossLinkModule}}
|
||||
{{else}}
|
||||
Module: {{#crossLinkModule module}}{{/crossLinkModule}}
|
||||
{{/if}}
|
||||
{{/if}}
|
||||
|
||||
{{#if since}}
|
||||
<p>Available since {{since}}</p>
|
||||
{{/if}}
|
||||
</div>
|
||||
|
||||
{{#if deprecated}}
|
||||
<div class="box deprecated">
|
||||
<p>
|
||||
{{#if deprecationMessage}}
|
||||
<strong>Deprecated:</strong> {{deprecationMessage}}
|
||||
{{else}}
|
||||
This class is deprecated.
|
||||
{{/if}}
|
||||
</p>
|
||||
</div>
|
||||
{{/if}}
|
||||
|
||||
<div class="box intro">
|
||||
{{{classDescription}}}
|
||||
</div>
|
||||
|
||||
{{#is_constructor}}
|
||||
<div class="constructor">
|
||||
<h2>Constructor</h2>
|
||||
{{>method}}
|
||||
</div>
|
||||
{{/is_constructor}}
|
||||
|
||||
<div id="classdocs" class="tabview">
|
||||
<ul class="api-class-tabs">
|
||||
<li class="api-class-tab index"><a href="#index">Index</a></li>
|
||||
|
||||
{{#if methods}}
|
||||
<li class="api-class-tab methods"><a href="#methods">Methods</a></li>
|
||||
{{/if}}
|
||||
{{#if properties}}
|
||||
<li class="api-class-tab properties"><a href="#properties">Properties</a></li>
|
||||
{{/if}}
|
||||
{{#if attrs}}
|
||||
<li class="api-class-tab attrs"><a href="#attrs">Attributes</a></li>
|
||||
{{/if}}
|
||||
{{#if events}}
|
||||
<li class="api-class-tab events"><a href="#events">Events</a></li>
|
||||
{{/if}}
|
||||
</ul>
|
||||
|
||||
<div>
|
||||
<div id="index" class="api-class-tabpanel index">
|
||||
<h2 class="off-left">Item Index</h2>
|
||||
|
||||
{{#if methods}}
|
||||
<div class="index-section methods">
|
||||
<h3>Methods</h3>
|
||||
|
||||
<ul class="index-list methods{{#if extends}} extends{{/if}}">
|
||||
{{#methods}}
|
||||
<li class="index-item method{{#if access}} {{access}}{{/if}}{{#if deprecated}} deprecated{{/if}}{{#if overwritten_from}} inherited{{/if}}{{#if extended_from}} inherited{{/if}}">
|
||||
<a href="#method_{{name}}">{{name}}</a>
|
||||
|
||||
{{#if static}}
|
||||
<span class="flag static">static</span>
|
||||
{{/if}}
|
||||
{{#if deprecated}}
|
||||
<span class="flag deprecated">deprecated</span>
|
||||
{{/if}}
|
||||
</li>
|
||||
{{/methods}}
|
||||
</ul>
|
||||
</div>
|
||||
{{/if}}
|
||||
|
||||
{{#if properties}}
|
||||
<div class="index-section properties">
|
||||
<h3>Properties</h3>
|
||||
|
||||
<ul class="index-list properties{{#if extends}} extends{{/if}}">
|
||||
{{#properties}}
|
||||
<li class="index-item property{{#if access}} {{access}}{{/if}}{{#if deprecated}} deprecated{{/if}}{{#if overwritten_from}} inherited{{/if}}{{#if extended_from}} inherited{{/if}}">
|
||||
<a href="#property_{{name}}">{{name}}</a>
|
||||
|
||||
{{#if static}}
|
||||
<span class="flag static">static</span>
|
||||
{{/if}}
|
||||
{{#if deprecated}}
|
||||
<span class="flag deprecated">deprecated</span>
|
||||
{{/if}}
|
||||
</li>
|
||||
{{/properties}}
|
||||
</ul>
|
||||
</div>
|
||||
{{/if}}
|
||||
|
||||
{{#if attrs}}
|
||||
<div class="index-section attrs">
|
||||
<h3>Attributes</h3>
|
||||
|
||||
<ul class="index-list attrs{{#if extends}} extends{{/if}}">
|
||||
{{#attrs}}
|
||||
<li class="index-item attr{{#if access}} {{access}}{{/if}}{{#if deprecated}} deprecated{{/if}}{{#if overwritten_from}} inherited{{/if}}{{#if extended_from}} inherited{{/if}}">
|
||||
<a href="#attr_{{name}}">{{name}}</a>
|
||||
</li>
|
||||
{{/attrs}}
|
||||
</ul>
|
||||
</div>
|
||||
{{/if}}
|
||||
|
||||
{{#if events}}
|
||||
<div class="index-section events">
|
||||
<h3>Events</h3>
|
||||
|
||||
<ul class="index-list events{{#if extends}} extends{{/if}}">
|
||||
{{#events}}
|
||||
<li class="index-item event{{#if access}} {{access}}{{/if}}{{#if deprecated}} deprecated{{/if}}{{#if overwritten_from}} inherited{{/if}}{{#if extended_from}} inherited{{/if}}">
|
||||
<a href="#event_{{name}}">{{name}}</a>
|
||||
|
||||
{{#if static}}
|
||||
<span class="flag static">static</span>
|
||||
{{/if}}
|
||||
{{#if deprecated}}
|
||||
<span class="flag deprecated">deprecated</span>
|
||||
{{/if}}
|
||||
</li>
|
||||
{{/events}}
|
||||
</ul>
|
||||
</div>
|
||||
{{/if}}
|
||||
</div>
|
||||
|
||||
{{#if methods}}
|
||||
<div id="methods" class="api-class-tabpanel">
|
||||
<h2 class="off-left">Methods</h2>
|
||||
|
||||
{{#methods}}
|
||||
{{>method}}
|
||||
{{/methods}}
|
||||
</div>
|
||||
{{/if}}
|
||||
|
||||
{{#if properties}}
|
||||
<div id="properties" class="api-class-tabpanel">
|
||||
<h2 class="off-left">Properties</h2>
|
||||
|
||||
{{#properties}}
|
||||
{{>props}}
|
||||
{{/properties}}
|
||||
</div>
|
||||
{{/if}}
|
||||
|
||||
{{#if attrs}}
|
||||
<div id="attrs" class="api-class-tabpanel">
|
||||
<h2 class="off-left">Attributes</h2>
|
||||
|
||||
{{#attrs}}
|
||||
{{>attrs}}
|
||||
{{/attrs}}
|
||||
</div>
|
||||
{{/if}}
|
||||
|
||||
{{#if events}}
|
||||
<div id="events" class="api-class-tabpanel">
|
||||
<h2 class="off-left">Events</h2>
|
||||
|
||||
{{#events}}
|
||||
{{>events}}
|
||||
{{/events}}
|
||||
</div>
|
||||
{{/if}}
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{{{customCrossLinks}}}
|
||||
Reference in New Issue
Block a user