Skip to content

Commit 3bfbf3c

Browse files
Narretzellimist
authored andcommitted
chore(doc-gen): render @example tag in ngdoc @method
Currently, ngdoc `@method` ignores `@example` tags and does not output them. This is usually not a problem, as examples are mostly defined directly in the `@description` via code blocks or `<example>` elements. However, some methods still have `@example` tags (possibly from a previous docs version). While not absolutely necessary, having special markup for Examples makes them a) easier to find visually in the docs, and b) easier to link to as they will have a unique id. Closes angular#14722 Closes angular#15448
1 parent 6b60883 commit 3bfbf3c

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

docs/config/templates/ngdoc/api/api.template.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ <h2 id="dependencies">Dependencies</h2>
5151

5252
{% block examples %}
5353
{%- if doc.examples %}
54-
<h2 id="example">Example</h2>
54+
<h2 id="example">Examples</h2>
5555
{%- for example in doc.examples -%}
5656
{$ example | marked $}
5757
{%- endfor -%}

docs/config/templates/ngdoc/lib/methods.template.html

+7
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,13 @@ <h4>Returns</h4>
2626
{$ lib.typeInfo(method.returns) $}
2727
{% endif %}
2828

29+
{%- if method.examples %}
30+
<h4 id="{$ doc.name $}.{$ method.name $}-examples">Examples</h4>
31+
{%- for example in method.examples -%}
32+
{$ example | marked $}
33+
{%- endfor -%}
34+
{% endif -%}
35+
2936
</li>
3037
{% endfor -%}
3138
</ul>

0 commit comments

Comments
 (0)