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
212
doxy/node/generators/yuidoc/tmpl/partials/method.handlebars
Normal file
212
doxy/node/generators/yuidoc/tmpl/partials/method.handlebars
Normal file
@ -0,0 +1,212 @@
|
||||
<div id="method_{{name}}" class="method item{{#if access}} {{access}}{{/if}}{{#if deprecated}} deprecated{{/if}}{{#if extended_from}} inherited{{/if}}">
|
||||
<h3 class="name"><code>{{name}}</code></h3>
|
||||
|
||||
{{#if params}}
|
||||
<div class="args">
|
||||
<span class="paren">(</span><ul class="args-list inline commas">
|
||||
{{#params}}
|
||||
<li class="arg">
|
||||
{{#if optional}}
|
||||
<code class="optional">[{{name}}{{#if optdefault}}={{optdefault}}{{/if}}]</code>
|
||||
{{else}}
|
||||
<code>{{name}}</code>
|
||||
{{/if}}
|
||||
</li>
|
||||
{{/params}}
|
||||
</ul><span class="paren">)</span>
|
||||
</div>
|
||||
{{else}}
|
||||
<span class="paren">()</span>
|
||||
{{/if}}
|
||||
|
||||
{{#if return}}
|
||||
<span class="returns-inline">
|
||||
<span class="type">{{#crossLink returnType}}{{/crossLink}}</span>
|
||||
</span>
|
||||
{{/if}}
|
||||
|
||||
{{#if deprecated}}
|
||||
<span class="flag deprecated"{{#if deprecationMessage}} title="{{deprecationMessage}}"{{/if}}>deprecated</span>
|
||||
{{/if}}
|
||||
|
||||
{{#if access}}
|
||||
<span class="flag {{access}}">{{access}}</span>
|
||||
{{/if}}
|
||||
|
||||
{{#if final}}
|
||||
<span class="flag final">final</span>
|
||||
{{/if}}
|
||||
|
||||
{{#if static}}
|
||||
<span class="flag static">static</span>
|
||||
{{/if}}
|
||||
|
||||
{{#if chainable}}
|
||||
<span class="flag chainable">chainable</span>
|
||||
{{/if}}
|
||||
|
||||
{{#if async}}
|
||||
<span class="flag async">async</span>
|
||||
{{/if}}
|
||||
|
||||
<div class="meta">
|
||||
{{#if overwritten_from}}
|
||||
<p>Inherited from
|
||||
<a href="{{crossLinkRaw overwritten_from/class}}#method_{{overwritten_from/name}}">
|
||||
{{overwritten_from/class}}
|
||||
</a>
|
||||
{{#if foundAt}}
|
||||
but overwritten in
|
||||
{{/if}}
|
||||
{{else}}
|
||||
{{#if extended_from}}
|
||||
<p>Inherited from
|
||||
<a href="{{crossLinkRaw extended_from}}#method_{{name}}">{{extended_from}}</a>:
|
||||
{{else}}
|
||||
{{#providedBy}}
|
||||
<p>Provided by the <a href="../modules/{{.}}.html">{{.}}</a> module.</p>
|
||||
{{/providedBy}}
|
||||
<p>
|
||||
{{#if foundAt}}
|
||||
Defined in
|
||||
{{/if}}
|
||||
{{/if}}
|
||||
{{/if}}
|
||||
{{#if foundAt}}
|
||||
<a href="{{foundAt}}">`{{{file}}}:{{{line}}}`</a>
|
||||
{{/if}}
|
||||
</p>
|
||||
|
||||
|
||||
{{#if deprecationMessage}}
|
||||
<p>Deprecated: {{deprecationMessage}}</p>
|
||||
{{/if}}
|
||||
|
||||
{{#if since}}
|
||||
<p>Available since {{since}}</p>
|
||||
{{/if}}
|
||||
</div>
|
||||
|
||||
<div class="description">
|
||||
{{{methodDescription}}}
|
||||
</div>
|
||||
|
||||
{{#if params}}
|
||||
<div class="params">
|
||||
<h4>Parameters:</h4>
|
||||
|
||||
<ul class="params-list">
|
||||
{{#params}}
|
||||
<li class="param">
|
||||
{{#if optional}}
|
||||
<code class="param-name optional">[{{name}}{{#if optdefault}}={{optdefault}}{{/if}}]</code>
|
||||
<span class="type">{{#crossLink type}}{{/crossLink}}</span>
|
||||
<span class="flag optional" title="This parameter is optional.">optional</span>
|
||||
{{else}}
|
||||
<code class="param-name">{{name}}</code>
|
||||
<span class="type">{{#crossLink type}}{{/crossLink}}</span>
|
||||
{{/if}}
|
||||
|
||||
{{#if multiple}}
|
||||
<span class="flag multiple" title="This argument may occur one or more times.">multiple</span>
|
||||
{{/if}}
|
||||
|
||||
<div class="param-description">
|
||||
{{{description}}}
|
||||
</div>
|
||||
|
||||
{{#if props}}
|
||||
<ul class="params-list">
|
||||
{{#props}}
|
||||
<li class="param">
|
||||
{{#if optional}}
|
||||
<code class="param-name optional">[{{name}}{{#if optdefault}}={{optdefault}}{{/if}}]</code>
|
||||
<span class="type">{{#crossLink type}}{{/crossLink}}</span>
|
||||
<span class="flag optional" title="This parameter is optional.">optional</span>
|
||||
{{else}}
|
||||
<code class="param-name">{{name}}</code>
|
||||
<span class="type">{{#crossLink type}}{{/crossLink}}</span>
|
||||
{{/if}}
|
||||
|
||||
<div class="param-description">
|
||||
{{{description}}}
|
||||
</div>
|
||||
|
||||
{{#if props}}
|
||||
<ul class="params-list">
|
||||
{{#props}}
|
||||
<li class="param">
|
||||
{{#if optional}}
|
||||
<code class="param-name optional">[{{name}}{{#if optdefault}}={{optdefault}}{{/if}}]</code>
|
||||
<span class="type">{{#crossLink type}}{{/crossLink}}</span>
|
||||
<span class="flag optional" title="This parameter is optional.">optional</span>
|
||||
{{else}}
|
||||
<code class="param-name">{{name}}</code>
|
||||
<span class="type">{{#crossLink type}}{{/crossLink}}</span>
|
||||
{{/if}}
|
||||
|
||||
<div class="param-description">
|
||||
{{{description}}}
|
||||
</div>
|
||||
</li>
|
||||
{{/props}}
|
||||
</ul>
|
||||
{{/if}}
|
||||
</li>
|
||||
{{/props}}
|
||||
</ul>
|
||||
{{/if}}
|
||||
</li>
|
||||
{{/params}}
|
||||
</ul>
|
||||
</div>
|
||||
{{/if}}
|
||||
|
||||
{{#return}}
|
||||
<div class="returns">
|
||||
<h4>Returns:</h4>
|
||||
|
||||
<div class="returns-description">
|
||||
{{#if description}}
|
||||
{{#if type}}
|
||||
<span class="type">{{#crossLink type}}{{/crossLink}}</span>:
|
||||
{{/if}}
|
||||
{{{description}}}
|
||||
{{else}}
|
||||
{{#if type}}
|
||||
<span class="type">{{#crossLink type}}{{/crossLink}}</span>:
|
||||
{{/if}}
|
||||
{{/if}}
|
||||
</div>
|
||||
</div>
|
||||
{{/return}}
|
||||
|
||||
{{#throws}}
|
||||
<div class="throws">
|
||||
<h4>Throws:</h4>
|
||||
|
||||
<div class="throws-description">
|
||||
{{#if description}}
|
||||
{{#if type}}
|
||||
<span class="type">{{#crossLink type}}{{/crossLink}}</span>:
|
||||
{{/if}}
|
||||
{{{description}}}
|
||||
{{else}}
|
||||
{{#if type}}
|
||||
<span class="type">{{#crossLink type}}{{/crossLink}}</span>:
|
||||
{{/if}}
|
||||
{{/if}}
|
||||
</div>
|
||||
</div>
|
||||
{{/throws}}
|
||||
|
||||
{{#example}}
|
||||
<div class="example">
|
||||
<h4>Example:</h4>
|
||||
|
||||
<div class="example-content">
|
||||
{{{.}}}
|
||||
</div>
|
||||
</div>
|
||||
{{/example}}
|
||||
</div>
|
||||
Reference in New Issue
Block a user