forked from Automattic/mongoose
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi.pug
More file actions
67 lines (62 loc) · 2.08 KB
/
Copy pathapi.pug
File metadata and controls
67 lines (62 loc) · 2.08 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
extends layout
append style
link(rel="stylesheet", href="/docs/css/api.css")
script(src="/docs/js/api-bold-current-nav.js")
block content
h1 API Docs
include includes/native
div.api-nav
div.api-nav-content
each item in docs
- if (!item.hideFromNav)
div.nav-item(id='nav-' + item.name)
div.nav-item-title
a(href='./api/' + item.name.toLowerCase() + '.html')
| #{item.name}
ul.nav-item-sub
each prop in item.props
li
a(href='./api/' + item.name.toLowerCase() + '.html#' + prop.anchorId)
| #{prop.string}
each item in docs
hr.separate-api
div.item-header-wrap
<a class="edit-docs-link" href="#{item.editLink}" target="_blank">
<img src="/docs/images/pencil.svg" />
</a>
h2(id=item.name, class="item-header")
a(href='#' + item.name)
| #{item.name}
ul
each prop in item.props
li
a(href='#' + prop.anchorId)
| #{prop.string}
each prop in item.props
hr.separate-api-elements
h3(id=prop.anchorId)
a(href='#' + prop.anchorId)
| #{prop.string}
if prop.param != null
h5 Parameters
ul.params
each param in prop.param
- if (param.nested)
ul(style="margin-top: 0.5em")
li
| #{param.name}
| <span class="method-type">«#{param.types}»</span> !{param.description}
- else
li.param
| #{param.name}
| <span class="method-type">«#{param.types}»</span> !{param.description}
if prop.return != null
h5 Returns:
ul
li <span class="method-type">«#{prop.return.types}»</span> !{prop.return.description}
if prop.type != null && prop.type !== 'method' && prop.type !== 'function'
h5 Type:
ul
li <span class="method-type">«#{prop.type}»</span>
div
| !{prop.description}