emmylua_doc_cli 0.22.0

A command-line tool for generating lua documentation.
Documentation 
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

# global {{ doc.name }}

{% if doc.property.description %}
{{ doc.property.description }}
{% endif %}

{% if doc.property.deprecated %}
@deprecated {{ doc.property.deprecated }}
{% endif %}

{% if doc.property.see %}
@see {{ doc.property.see }}
{% endif %}

{% if doc.property.other %}
{{ doc.property.other }}
{% endif %}
---
{% if doc.methods %}
## methods
---
{% for method in doc.methods %}
### {{ method.name }}
---
{{ method.display }}

{% if method.property.description %}
{{ method.property.description }}
{% endif %}

{% if method.property.deprecated %}
@deprecated {{ method.property.deprecated }}
{% endif %}

{% if method.property.see %}
@see {{ method.property.see }}
{% endif %}

{% if method.property.other %}
{{ method.property.other }}
{% endif %}
{% endfor %}
{% endif %}

{% if doc.fields %}
## fields
---
{% for field in doc.fields %}
### {{ field.name }}
---
{{ field.display }}

{% if field.property.description %}
{{ field.property.description }}
{% endif %}

{% if field.property.deprecated %}
@deprecated {{ field.property.deprecated }}
{% endif %}

{% if field.property.see %}
@see {{ field.property.see }}
{% endif %}

{% if field.property.other %}
{{ field.property.other }}
{% endif %}
{% endfor %}
{% endif %}