-
Notifications
You must be signed in to change notification settings - Fork 2
/
markdown.hbs
43 lines (35 loc) · 787 Bytes
/
markdown.hbs
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
## `{{name}}`
{{#description}}
{{inlines .}}
{{/description}}
{{#if params}}
### Parameters
{{#params}}
* `{{name}}` **{{format_type type}}** {{format_description description}}{{#default}} (optional, default `{{.}}`){{/default}}
{{/params}}
{{/if}}
{{#if properties}}
| name | type | description |
| ---- | ---- | ----------- |
{{#properties}}
| `{{name}}` | {{format_type type}} | {{format_description description}} |
{{/properties}}
{{/if}}
{{#if examples}}
### Examples
{{#each examples ~}}
```js
{{{.}}}
```
{{/each}}
{{/if}}
{{#returns}}
Returns {{#type.name}}`{{.}}`{{/type.name}} {{inlines description}}
{{/returns}}
{{#if throws}}
| type | description |
| ---- | ----------- |
{{#throws}}
| {{format_type type}} | {{format_description description}} |
{{/throws}}
{{/if}}