Files
meteor/docs/client/api-box.html
Sashko Stubailo dbaf42e6ea Add capability for instance documentation, added dependency
Broke some links, going to fix those later
2014-08-26 10:12:32 -07:00

100 lines
1.9 KiB
HTML

<template name="api_box">
<div class="api {{bare}}">
<h3 id="{{id}}">
<a class="name selflink" href="#{{id}}">{{{name}}}</a>
{{#if locus}}
<span class="locus">{{locus}}</span>
{{/if}}
</h3>
<div class="desc">
{{#each descr}}{{#markdown}}{{{this}}}{{/markdown}}{{/each}}
</div>
{{#if args}}
<h4>Arguments</h4>
{{> api_box_args args}}
{{/if}}
{{#if options}}
<h4>Options</h4>
{{> api_box_args options}}
{{/if}}
{{#if UI.contentBlock}}
{{#markdown}}{{> UI.contentBlock}}{{/markdown}}
{{/if}}
</div>
</template>
<template name="autoApiBox">
{{#with apiData this}}
<div class="api {{bare}}">
<h3 id="{{link}}">
<a class="name selflink" href="#{{link}}">
{{{name}}}({{paramsSentence}})
</a>
{{#if locus}}
<span class="locus">{{locus}}</span>
{{/if}}
</h3>
<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>