generated from defold/template-native-extension
-
Notifications
You must be signed in to change notification settings - Fork 19
/
api_markdown.mtl
46 lines (37 loc) · 1.05 KB
/
api_markdown.mtl
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
# API reference
{{#groups}}
* {{group}}
{{#files}}
* [{{#type}}{{type}}{{/type}}{{^type}}{{module}}{{/type}}](#{{#type}}{{type}}{{/type}}{{^type}}{{module}}{{/type}})
{{/files}}
{{/groups}}
{{#groups}}
# {{group}}
{{#files}}
## {{#type}}{{type}}{{/type}}{{^type}}{{module}}{{/type}}
*File: `{{filename}}`*
{{#file_summary}}{{file_summary}} {{/file_summary}}{{file_description}}
{{#usage}}
```lua
{{{usage}}}```{{/usage}}
{{#entries}}
{{#type}}
### {{type}}.{{name}}{{#field_type}} [`{{field_type}}`]{{/field_type}}{{^field}}({{params_string}}){{/field}}
{{/type}}
{{^type}}
### {{name}}{{#field_type}} [`{{field_type}}`]{{/field_type}}{{^field}}({{params_string}}){{/field}}
{{/type}}
{{#summary}}{{summary}} {{/summary}}{{description}}
{{#usage}}```
{{{usage}}}```{{/usage}}
{{#has_params}}
PARAMS
{{#params}}* `{{name}}` {{#type}}[`{{type}}`] {{/type}}- {{description}}
{{/params}}{{/has_params}}{{#has_returns}}
RETURNS
{{#returns}}* `{{name}}` {{#type}}[`{{type}}`] {{/type}}- {{description}}
{{/returns}}{{/has_returns}}
{{/entries}}
---
{{/files}}
{{/groups}}