Skip to content

Commit 09e6e76

Browse files
Add param comments for destructing parameter, update test specs
1 parent 9c7dd85 commit 09e6e76

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

examples/basic/src/typescript-1.5.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@ var [destructArrayWithIgnoresA, , ...destructArrayWithIgnoresRest] = [1, 2, 3, 4
2121

2222
/**
2323
* Destructuring function parameters.
24+
*
25+
* @param text This is the text
26+
* @param location This is the location
27+
* @param bold Should it be bold?
2428
*/
2529
function drawText({text = "", location:[x, y] = [0, 0], bold = false}) {
2630
}

test/renderer/specs/modules/_typescript_1_5_.html

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ <h3>draw<wbr>Text</h3>
221221
<li class="tsd-description">
222222
<aside class="tsd-sources">
223223
<ul>
224-
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/typescript-1.5.ts#L25">typescript-1.5.ts:25</a></li>
224+
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/typescript-1.5.ts#L29">typescript-1.5.ts:29</a></li>
225225
</ul>
226226
</aside>
227227
<div class="tsd-comment tsd-typography">
@@ -236,12 +236,21 @@ <h5>__namedParameters: <span class="tsd-signature-type">object</span></h5>
236236
<ul class="tsd-parameters">
237237
<li class="tsd-parameter">
238238
<h5>bold<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
239+
<div class="tsd-comment tsd-typography">
240+
<p>Should it be bold?</p>
241+
</div>
239242
</li>
240243
<li class="tsd-parameter">
241244
<h5>location<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span></h5>
245+
<div class="tsd-comment tsd-typography">
246+
<p>This is the location</p>
247+
</div>
242248
</li>
243249
<li class="tsd-parameter">
244250
<h5>text<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
251+
<div class="tsd-comment tsd-typography">
252+
<p>This is the text</p>
253+
</div>
245254
</li>
246255
</ul>
247256
</li>

0 commit comments

Comments
 (0)