Skip to content

Commit 5565b07

Browse files
committed
show caption tag in example (jsdoc/jsdoc#944)
1 parent a6b7763 commit 5565b07

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

content/en/tags-example.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Examples can also be captioned using `<caption></caption>` after the @example ta
3939
```js
4040
/**
4141
* Solves equations of the form a * x = b
42-
* @example <caption>Example usage of method1.</caption>
42+
* @example &lt;caption>Example usage of method1.&lt;/caption>
4343
* // returns 2
4444
* globalNS.method1(5, 10);
4545
* @returns {Number} Returns the value of x for the equation.

tags-example.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ <h2 id="examples">Examples</h2>
5555
<figure>
5656
<figcaption>Documenting examples with a caption</figcaption><pre class="prettyprint lang-js"><code>/**
5757
* Solves equations of the form a * x = b
58-
* @example <caption>Example usage of method1.</caption>
58+
* @example &lt;caption>Example usage of method1.&lt;/caption>
5959
* // returns 2
6060
* globalNS.method1(5, 10);
6161
* @returns {Number} Returns the value of x for the equation.

0 commit comments

Comments
 (0)