doxdox-plugin-markdown/template.hbs at master · docsbydoxdox/doxdox-plugin-markdown · GitHub

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
{{#if pkg.homepage}}
# [{{title}}]({{pkg.homepage}}) {{#if pkg.version}}*{{pkg.version}}*{{/if}}
{{else}}
# {{title}} {{#if pkg.version}}*{{pkg.version}}*{{/if}}
{{/if}}

{{#if description}}
> {{description}}
{{/if}}

{{#each files}}

### {{name}}

{{#each methods}}

#### {{name}}({{params}}) {{#if isPrivate}} *private method*{{/if}}

{{{description}}}

{{{body}}}

{{#if tags.param}}

##### Parameters

| Name | Type | Description |  |
| ---- | ---- | ----------- | -------- |
{{#each tags.param}}
| {{name}} | {{#each types}}`{{{.}}}` {{/each}} | {{{replaceNewLinesWithBR description}}} | {{#if isOptional}}*Optional*{{else}}&nbsp;{{/if}} |
{{/each}}

{{/if}}

{{#if tags.property}}

##### Properties

| Name | Type | Description |  |
| ---- | ---- | ----------- | -------- |
{{#each tags.param}}
| {{name}} | {{#each types}}`{{{.}}}` {{/each}} | {{{replaceNewLinesWithBR description}}} | {{#if isOptional}}*Optional*{{else}}&nbsp;{{/if}} |
{{/each}}

{{/if}}

{{#if tags.example}}

##### Examples

{{#each tags.example}}
```javascript
{{{.}}}
```
{{/each}}

{{/if}}

##### Returns

{{#if tags.return}}

{{#each tags.return}}
- {{#each types}}`{{.}}` {{/each}} {{{description}}}
{{/each}}

{{else}}

- `Void`

{{/if}}

{{/each}}

{{/each}}

*Documentation generated with [doxdox](https://github.com/neogeek/doxdox).*