Skip to content

Commit 3fe729e

Browse files
committed
🆕 Template for metadata tags
Generates a md table with @author, @deprecated, @SInCE, @see and @link references
1 parent e133910 commit 3fe729e

File tree

6 files changed

+78
-90
lines changed

6 files changed

+78
-90
lines changed

data/templates/vuepress/class.md.twig

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -79,27 +79,7 @@
7979
{%- endfor -%}
8080
|
8181

82-
| | |
83-
|:---:| --- |
84-
| **Authors** |
85-
{%- for author in class.tags.author -%}
86-
{{ author.description }} <br />
87-
{%- endfor -%}
88-
|
89-
90-
91-
{% if class.tags.see is not empty or class.tags.link is not empty %}
92-
***See Also:***
93-
94-
{% for see in class.tags.see %}
95-
* `{{ see.reference }}` {% if see.description %}-{% endif %} {{ see.description }}
96-
{% endfor %}
97-
98-
{% for link in class.tags.link %}
99-
* [{{ link.description|default(link.link) }}]({{ link.link }})
100-
{% endfor %}
101-
102-
{% endif %}{# class.tags.see || class.tags.link #}
82+
{{ include('metadata-table.md.twig', { elem: class }) }}
10383

10484
{% set methodsList = [] %}
10585
### <span style="display: none;">{{ class }}</span> Methods

data/templates/vuepress/interface.md.twig

Lines changed: 2 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
{{ interface.description|replace({'#### ': '- ', '### ': '- ', '## ': '- ', '# ': '- ',}) }}
66

7+
78
{#- Parents -#}
89
{% set parents = [] %}
910

@@ -37,27 +38,7 @@
3738
{%- endfor -%}
3839
|
3940

40-
| | |
41-
|:---:| --- |
42-
| **Authors** |
43-
{%- for author in interface.tags.author -%}
44-
{{ author.description }} <br />
45-
{%- endfor -%}
46-
|
47-
48-
49-
{% if interface.tags.see is not empty or interface.tags.link is not empty %}
50-
***See Also:***
51-
52-
{% for see in interface.tags.see %}
53-
* `{{ see.reference }}` {% if see.description %}-{% endif %} {{ see.description }}
54-
{% endfor %}
55-
56-
{% for link in interface.tags.link %}
57-
* [{{ link.description|default(link.link) }}]({{ link.link }})
58-
{% endfor %}
59-
60-
{% endif %}{# interface.tags.see || interface.tags.link #}
41+
{{ include('metadata-table.md.twig', { elem: interface }) }}
6142

6243
### <span style="display: none;">{{ interface }}</span> Methods
6344
{# Lista de métodos públicos y protegidos #}
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
| | |
2+
|:--------:| ----------- |
3+
{{ '' }}
4+
5+
{%- if elem.tags.since is not empty %}
6+
| ***Since*** |
7+
{%- for since in elem.tags.since -%}
8+
`
9+
{%- if since.version -%}
10+
v
11+
{%- endif -%}
12+
13+
{{- since.version|default('undefined') -}}
14+
`
15+
16+
{%- if since.description -%}
17+
{{ ': ' ~ since.description }}
18+
{%- endif -%}
19+
20+
<br />
21+
{%- endfor -%}
22+
|
23+
{% endif %}
24+
25+
{%- if elem.deprecated %}
26+
| **Deprecated** |
27+
{%- for deprecated in elem.tags.deprecated -%}
28+
{%- if deprecated.version -%}
29+
Since `v{{ deprecated.version }}`
30+
31+
{%- if deprecated.description -%}
32+
{{ ': ' }}
33+
{%- endif -%}
34+
35+
{%- elseif deprecated.description is empty -%}
36+
Yes
37+
{%- endif -%}
38+
39+
{{ deprecated.description }} <br />
40+
{%- endfor -%}
41+
|
42+
{% endif %}
43+
44+
{%- if elem.tags.author is not empty %}
45+
| **Authors** |
46+
{%- for author in elem.tags.author -%}
47+
{{ author.description }} <br />
48+
{%- endfor -%}
49+
|
50+
{% endif %}
51+
52+
{%- if elem.tags.see is not empty or elem.tags.link is not empty %}
53+
| **See also** |
54+
{%- for see in elem.tags.see -%}
55+
`{{ see.reference }}` {% if see.description %}<br />{% endif %} {{ see.description }} <br /> {# TODO: Make references linkables #}
56+
{%- endfor -%}
57+
58+
{%- for link in elem.tags.link -%}
59+
[{{ link.description|default(link.link) }}]({{ link.link }}) <br />
60+
{%- endfor -%}
61+
|
62+
{% endif %}

data/templates/vuepress/method.md.twig

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -28,25 +28,14 @@
2828
{{ method.description|replace({'#### ': '- ', '### ': '- ', '## ': '- ', '# ': '- ',}) }}
2929
{% endif %}
3030

31+
{{ include('metadata-table.md.twig', { elem: method }) }}
32+
33+
3134
{% if method.response.description %}
32-
***Return Value:***
35+
***Returns:***
3336

3437
{{ method.response.description|raw }}
3538

3639
{% endif %}
3740

38-
39-
{% if method.tags.see is not empty or method.tags.link is not empty %}
40-
***See Also:***
41-
42-
{% for see in method.tags.see %}
43-
* `{{ see.reference }}` {% if see.description %}-{% endif %} {{ see.description }}
44-
{% endfor %}
45-
46-
{% for link in class.tags.link %}
47-
* [{{ link.description|default(link.link) }}]({{ link.link }})
48-
{% endfor %}
49-
50-
{% endif %}{# class.tags.see || class.tags.link #}
51-
5241
:::

data/templates/vuepress/property.md.twig

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -30,18 +30,6 @@
3030
{{ property.description|replace({'#### ': '- ', '### ': '- ', '## ': '- ', '# ': '- ',}) }}
3131
{% endif %}
3232

33-
34-
{% if method.tags.see is not empty or method.tags.link is not empty %}
35-
***See Also:***
36-
37-
{% for see in method.tags.see %}
38-
* `{{ see.reference }}` {% if see.description %}-{% endif %} {{ see.description }}
39-
{% endfor %}
40-
41-
{% for link in class.tags.link %}
42-
* [{{ link.description|default(link.link) }}]({{ link.link }})
43-
{% endfor %}
44-
45-
{% endif %}{# class.tags.see || class.tags.link #}
33+
{{ include('metadata-table.md.twig', { elem: property }) }}
4634

4735
:::

data/templates/vuepress/trait.md.twig

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
{{ trait.summary|replace({'#### ': '- ', '### ': '- ', '## ': '- ', '# ': '- ',}) }}
44

5-
{{ trait.description|replace({'#### ': '- ', '### ': '- ', '## ': '- ', '# ': '- ',}) }}
65

76
{#- Used traits -#}
87
{% set usedTraits = [] %}
@@ -29,7 +28,7 @@
2928

3029
| | |
3130
| ---:| --- |
32-
| ***Uses*** {# FIXME #} |
31+
| **Uses** {# FIXME #} |
3332
{%- for tName, tShort in usedTraits if tShort is not empty -%}
3433
[{{ tName|trim('\\')|split('\\')|slice(0, -1)|join('\\') }}\\<span style="font-weight: bold;">{{ tShort }}</span>](/api/traits.html#
3534
{{- tName|trim('\\')|lower|replace('\\', '-') }}) <br />
@@ -38,27 +37,16 @@
3837
{%- endfor -%}
3938
|
4039

41-
| | |
42-
|:---:| --- |
43-
| ***Authors*** |
44-
{%- for author in trait.tags.author -%}
45-
{{ author.description }} <br />
46-
{%- endfor -%}
47-
|
48-
49-
50-
{% if trait.tags.see is not empty or trait.tags.link is not empty %}
51-
***See Also:***
40+
### Description
5241

53-
{% for see in trait.tags.see %}
54-
* `{{ see.reference }}` {% if see.description %}-{% endif %} {{ see.description }}
55-
{% endfor %}
42+
{% if trait.description %}
43+
{{ trait.description|replace({'#### ': '- ', '### ': '- ', '## ': '- ', '# ': '- ',}) -}}
44+
{% else %}
45+
> No description.
46+
{% endif %}
5647

57-
{% for link in trait.tags.link %}
58-
* [{{ link.description|default(link.link) }}]({{ link.link }})
59-
{% endfor %}
48+
{{ include('metadata-table.md.twig', { elem: trait}) }}
6049

61-
{% endif %}{# class.tags.see || class.tags.link #}
6250

6351
### <span style="display: none;">{{ trait }}</span> Methods
6452
{# Lista de métodos públicos y protegidos #}

0 commit comments

Comments
 (0)