forked from meteor/meteor
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi-box.html
More file actions
91 lines (83 loc) · 1.97 KB
/
api-box.html
File metadata and controls
91 lines (83 loc) · 1.97 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
<template name="apiBoxTitle">
<h3 id="{{id}}" class="api-title">
<div class="locus">
{{locus}}
</div>
<a class="name selflink" href="{{link}}">{{{name}}}</a>
<div class="subtext">
{{#if importName}}
<code>import { {{importName}} } from 'meteor/{{module}}'</code>
{{/if}}
{{#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}}
</div>
</h3>
</template>
<template name="autoApiBox">
{{#with apiData this}}
<div class="api {{bare}} new-api-box">
{{> apiBoxTitle
name=signature
importName=importName
module=module
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>