Files
meteor/docs/client/api-box.html
zyzo 4689ee7dfa Issue #3916: Add links to GitHub source code to docs
PR #3934

[stubailo: some improvements]
2015-04-01 17:21:05 -07:00

80 lines
1.7 KiB
HTML

<template name="apiBoxTitle">
<h3 id="{{id}}" class="api-title">
<div class="locus">
{{locus}}
</div>
<a class="name selflink" href="{{link}}">{{{name}}}</a>
{{#if fullApi}}
{{#if filepath}}
<a class="src-code" href="https://github.com/meteor/meteor/blob/master/packages/{{filepath}}#L{{lineno}}" target="_blank">
{{filepath}}, line {{lineno}}
</a>
{{/if}}
{{/if}}
</h3>
</template>
<template name="autoApiBox">
{{#with apiData this}}
<div class="api {{bare}} new-api-box">
{{> apiBoxTitle name=signature locus=locus id=id filepath=filepath lineno=lineno}}
<div class="desc">
{{#markdown}}{{summary}}{{/markdown}}
</div>
{{#if paramsNoOptions}}
<h4>Arguments</h4>
<dl class="args">
{{#each paramsNoOptions}}
<dt>
<span class="name">{{name}}</span>
<span class="type">{{{typeNames type.names}}}</span>
</dt>
<dd>
{{{description}}}
</dd>
{{/each}}
</dl>
{{/if}}
{{#if options}}
<h4>Options</h4>
<dl class="args">
{{#each options}}
<dt>
<span class="name">{{name}}</span>
<span class="type">{{{typeNames type.names}}}</span>
</dt>
<dd>
{{{description}}}
</dd>
{{/each}}
</dl>
{{/if}}
{{#if UI.contentBlock}}
{{#markdown}}{{> UI.contentBlock}}{{/markdown}}
{{/if}}
</div>
{{/with}}
</template>
<template name="api_box_args">
<dl class="args">
{{#each this}}
<dt><span class="name">{{{name}}}</span>
<span class="type">
{{#if type_link}}
<a href="#{{type_link}}">{{{type}}}</a>
{{else}}
{{{type}}}
{{/if}}
</span></dt>
<dd>{{#markdown}}{{{descr}}}{{/markdown}}</dd>
{{/each}}
</dl>
</template>