phpdoc-md/templates/class.twig at 8f18bb354c6827d2d2c3c0e7e65838b0a239a0eb · evert/phpdoc-md · 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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
{{ className }}
===============

{{ description }}

{{ longDescription|raw }}

{% if isClass %}

* Class name: {{ shortClass }}
* Namespace: {{ namespace }}
{% if abstract %}* This is an **abstract** class
{% endif %}
{% if extends[0] %}* Parent class: {{ extends.0|classLink }}
{% endif %}
{% if implements %}* This class implements: {% for interface in implements %}{{ interface|classLink }}{%if not loop.last %}, {% endif %}{% endfor %}
{% endif %}
{% if deprecated %}* **Warning:** this class is **deprecated**. This means that this class will likely be removed in a future version.
{% endif %}

{% endif %}

{% if isInterface %}
* Interface name: {{ shortClass }}
* Namespace: {{ namespace }}
* This is an **interface**
{% if extends %}* This interface extends: {% for interface in extends %}{{ interface|classLink }}{%if not loop.last %}, {% endif %}{% endfor %}
{% endif %}
{% if deprecated %}* **Warning:** this interface is **deprecated**. This means that this interface will likely be removed in a future version.
{% endif %}

{% endif %}

{% if constants %}
Constants
----------
{% endif %}

{% for constant in constants %}

### {{ constant.name }}

    {{ constant.signature|raw }}

{{ constant.description|raw }}

{% if constant.deprecated %}* **Warning:** this constant is **deprecated**. This means that this constant will likely be removed in a future version.
{% endif %}

{% endfor %}

{% if properties %}
Properties
----------
{% endif %}

{% for property in properties %}

### {{ property.name }}

    {{ property.signature|raw }}

{{ property.description|raw }}

* Visibility: **{{ property.visibility }}**
{% if property.deprecated %}* **Warning:** this property is **deprecated**. This means that this property will likely be removed in a future version.
{% endif %}
{% if property.static %}* This property is **static**.
{% endif %}
{% if property.definedBy != className %}* This property is defined by {{ property.definedBy|classLink }}
{% endif %}

{% endfor %}

{% if methods %}
Methods
-------
{% endif %}

{% for method in methods %}

### {{ method.name }}

    {{ method.signature|raw }}

{{ method.description|raw }}

* Visibility: **{{ method.visibility }}**
{% if method.abstract %}* This method is **abstract**.
{% endif %}
{% if method.static %}* This method is **static**.
{% endif %}
{% if method.deprecated %}* **Warning:** this method is **deprecated**. This means that this method will likely be removed in a future version.
{% endif %}
{% if method.definedBy != className %}* This method is defined by {{ method.definedBy|classLink }}
{% endif %}


{% if method.arguments %}
#### Arguments
{% for argument in method.arguments %}
* {{ argument.name }} **{% if argument.type %}{{ argument.type|classLink }}{% else %}mixed{% endif %}**{% if argument.description %} - {{ argument.description }}{% endif %}

{% endfor %}

{% endif %}

{% endfor %}