Mailspring/docs-templates/_function.html
Ben Gotow 7edafa3819 feat(docs): doc site generation, doc organization into sections, docs for actions and more
Summary: Lots o docs

Test Plan: Run tests, review docs

Reviewers: evan

Reviewed By: evan

Differential Revision: https://review.inboxapp.com/D1496
2015-05-13 11:44:28 -07:00

40 lines
1.1 KiB
HTML

<h4 id={{name}} class="function-name">
{{name}}(<span class="args">{{#each arguments}}<span class="arg">{{#if isOptional}}[{{/if}}{{name}}{{#if isOptional}}]{{/if}}</span>{{/each}}</span>) <a href="#{{name}}" class="link"></a>
</h4>
<div class="function-description markdown-from-sourecode">
<p>{{{description}}}</p>
</div>
{{#if arguments.length}}
<strong>Parameters</strong>
<table class="arguments">
<tr>
<th>Argument</th>
<th>Description</th>
</tr>
{{#each arguments}}
<tr>
<td style="width:15%;">
<em>{{name}}</em>
</td>
<td class="markdown-from-sourecode">
{{#if isOptional}}<span class="optional">Optional</span>{{/if}}
{{{description}}}
</td>
</tr>
{{/each}}
</table>
{{/if}}
{{#if returnValues.length}}
<strong>Returns</strong>
<table class="arguments">
<tr>
<th>Return Values</th>
</tr>
{{#each returnValues}}
<tr><td class="markdown-from-sourecode">{{{description}}}</td></tr>
{{/each}}
</table>
{{/if}}