fix: Ensure child comment tags get set (#1221)

* add comments array to reflection object * Fixed issue in CommentPlugin where comments were not always being entirely copied over to signature * Fixed CommentPlugin issue where tags weren't always being copied over to child comments inside signatures. Also updated test specs to match the expected output. Should now output the `@see` tags defined in the comments for the test fat arrow functions
TypeStrong · Feb 28, 2020 · 541fbcf · 541fbcf
1 parent 796349a
commit 541fbcf
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 0 deletions.
diff --git a/src/lib/converter/plugins/CommentPlugin.ts b/src/lib/converter/plugins/CommentPlugin.ts
@@ -307,6 +307,7 @@ export class CommentPlugin extends ConverterComponent {
                     childComment.shortText = childComment.shortText || comment.shortText;
                     childComment.text      = childComment.text      || comment.text;
                     childComment.returns   = childComment.returns   || comment.returns;
+                    childComment.tags      = childComment.tags      || comment.tags;
                 }
 
                 if (signature.parameters) {

diff --git a/src/test/renderer/specs/classes/_classes_.baseclass.html b/src/test/renderer/specs/classes/_classes_.baseclass.html
@@ -287,6 +287,11 @@ <h3>arrow<wbr>Function</h3>
 								<div class="lead">
 									<p>This is a simple fat arrow function.</p>
 								</div>
+								<dl class="tsd-comment-tags">
+									<dt>see</dt>
+									<dd><p><a href="https://github.com/sebastian-lenz/typedoc/issues/37">https://github.com/sebastian-lenz/typedoc/issues/37</a></p>
+									</dd>
+								</dl>
 							</div>
 							<h4 class="tsd-parameters-title">Parameters</h4>
 							<ul class="tsd-parameters">

diff --git a/src/test/renderer/specs/classes/_classes_.subclassa.html b/src/test/renderer/specs/classes/_classes_.subclassa.html
@@ -391,6 +391,11 @@ <h3>arrow<wbr>Function</h3>
 								<div class="lead">
 									<p>This is a simple fat arrow function.</p>
 								</div>
+								<dl class="tsd-comment-tags">
+									<dt>see</dt>
+									<dd><p><a href="https://github.com/sebastian-lenz/typedoc/issues/37">https://github.com/sebastian-lenz/typedoc/issues/37</a></p>
+									</dd>
+								</dl>
 							</div>
 							<h4 class="tsd-parameters-title">Parameters</h4>
 							<ul class="tsd-parameters">

diff --git a/src/test/renderer/specs/classes/_classes_.subclassb.html b/src/test/renderer/specs/classes/_classes_.subclassb.html
@@ -255,6 +255,11 @@ <h3>arrow<wbr>Function</h3>
 								<div class="lead">
 									<p>This is a simple fat arrow function.</p>
 								</div>
+								<dl class="tsd-comment-tags">
+									<dt>see</dt>
+									<dd><p><a href="https://github.com/sebastian-lenz/typedoc/issues/37">https://github.com/sebastian-lenz/typedoc/issues/37</a></p>
+									</dd>
+								</dl>
 							</div>
 							<h4 class="tsd-parameters-title">Parameters</h4>
 							<ul class="tsd-parameters">