fix: Set inheritedFrom on accessor signatures

Gerrit0 · Gerrit0 · commit ccd519a82d7a · 2021-02-06T14:54:29.000-07:00
Resolves #1497 Also copy comments for inherited/implemented members which do not already have a comment - resolves #1498.
diff --git a/examples/basic/src/classes.ts b/examples/basic/src/classes.ts
@@ -16,10 +16,10 @@ export interface NameInterface {
      *
      * It should be inherited by all subinterfaces.
      *
-     * Links - these should all point to this property:
+     * Links - these should all point to this property on the base class
      * - {@link name}
      * - {@link NameInterface.name}
-     * - {@link "classes".NameInterface.name}
+     * - {@link classes.NameInterface.name}
      * - {@link name Text} &lt;-- This one goes away eventually
      * - {@link name|Text}
      * - {@link name | Text}
diff --git a/src/lib/converter/plugins/ImplementsPlugin.ts b/src/lib/converter/plugins/ImplementsPlugin.ts
@@ -83,6 +83,22 @@ export class ImplementsPlugin extends ConverterComponent {
                 );
                 copyComment(classMember, interfaceMember);
 
+                if (
+                    interfaceMember.kindOf(ReflectionKind.Property) &&
+                    classMember.kindOf(ReflectionKind.Accessor)
+                ) {
+                    if (classMember.getSignature) {
+                        copyComment(classMember.getSignature, interfaceMember);
+                        classMember.getSignature.implementationOf =
+                            classMember.implementationOf;
+                    }
+                    if (classMember.setSignature) {
+                        copyComment(classMember.setSignature, interfaceMember);
+                        classMember.setSignature.implementationOf =
+                            classMember.implementationOf;
+                    }
+                }
+
                 if (
                     interfaceMember.kindOf(ReflectionKind.FunctionOrMethod) &&
                     interfaceMember.signatures &&
diff --git a/src/lib/converter/plugins/InheritDocPlugin.ts b/src/lib/converter/plugins/InheritDocPlugin.ts
@@ -64,7 +64,7 @@ export class InheritDocPlugin extends ConverterComponent {
                     source instanceof DeclarationReflection &&
                     item instanceof SignatureReflection
                 ) {
-                    const isFunction = source?.kindOf(
+                    const isFunction = source.kindOf(
                         ReflectionKind.FunctionOrMethod
                     );
                     if (isFunction) {
diff --git a/src/lib/converter/utils/reflections.ts b/src/lib/converter/utils/reflections.ts
@@ -49,7 +49,7 @@ export function copyComment(target: Reflection, source: Reflection) {
              * TSDoc overrides existing parameters entirely with inherited ones, while
              * existing implementation merges them.
              * To avoid breaking things, `inheritDoc` tag is additionally checked for the parameter,
-             * so the previous behaviour will continue to work.
+             * so the previous behavior will continue to work.
              *
              * TODO: When breaking change becomes acceptable remove legacy implementation
              */
@@ -61,6 +61,15 @@ export function copyComment(target: Reflection, source: Reflection) {
         }
         target.comment.removeTags("inheritdoc");
         target.comment.copyFrom(source.comment);
+    } else if (!target.comment && source.comment) {
+        if (
+            target instanceof DeclarationReflection &&
+            source instanceof DeclarationReflection
+        ) {
+            target.typeParameters = source.typeParameters;
+        }
+        target.comment = new Comment();
+        target.comment.copyFrom(source.comment);
     }
 }
 
diff --git a/src/test/converter/interface/specs.json b/src/test/converter/interface/specs.json
@@ -1027,6 +1027,9 @@
                       "kind": 4096,
                       "kindString": "Call signature",
                       "flags": {},
+                      "comment": {
+                        "shortText": "Remove this subscription from its dispatcher"
+                      },
                       "type": {
                         "type": "intrinsic",
                         "name": "void"
diff --git a/src/test/renderer/specs/classes/classes.subclassa.html b/src/test/renderer/specs/classes/classes.subclassa.html
@@ -200,6 +200,27 @@ <h3>name</h3>
 						<p>Implementation of <a href="../interfaces/classes.printnameinterface.html">PrintNameInterface</a>.<a href="../interfaces/classes.printnameinterface.html#name">name</a></p>
 						<p>Overrides <a href="classes.baseclass.html">BaseClass</a>.<a href="classes.baseclass.html#name">name</a></p>
 					</aside>
+					<div class="tsd-comment tsd-typography">
+						<div class="lead">
+							<p>This is a interface member of INameInterface.</p>
+						</div>
+						<p>It should be inherited by all subinterfaces.</p>
+						<p>Links - these should all point to this property on the base class</p>
+						<ul>
+							<li><a href="classes.subclassa.html#name">name</a></li>
+							<li><a href="../interfaces/classes.nameinterface.html#name">NameInterface.name</a></li>
+							<li><a href="../interfaces/classes.nameinterface.html#name">classes.NameInterface.name</a></li>
+							<li><a href="classes.subclassa.html#name">Text</a> &lt;-- This one goes away eventually</li>
+							<li><a href="classes.subclassa.html#name">Text</a></li>
+							<li><a href="classes.subclassa.html#name">Text</a></li>
+							<li><a href="../interfaces/classes.nameinterface.html#name">Text</a></li>
+						</ul>
+						<p>Links - these should point to the containing interface</p>
+						<ul>
+							<li><a href="../interfaces/classes.nameinterface.html">NameInterface</a></li>
+							<li>{@link &quot;classes&quot;.NameInterface}</li>
+						</ul>
+					</div>
 				</section>
 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static">
 					<a name="instance" class="tsd-anchor"></a>
diff --git a/src/test/renderer/specs/classes/classes.subclassb.html b/src/test/renderer/specs/classes/classes.subclassb.html
@@ -170,6 +170,11 @@ <h3>name</h3>
 					<aside class="tsd-sources">
 						<p>Overrides <a href="classes.baseclass.html">BaseClass</a>.<a href="classes.baseclass.html#name">name</a></p>
 					</aside>
+					<div class="tsd-comment tsd-typography">
+						<div class="lead">
+							<p>This is a simple public member.</p>
+						</div>
+					</div>
 				</section>
 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static">
 					<a name="instance" class="tsd-anchor"></a>
diff --git a/src/test/renderer/specs/interfaces/classes.nameinterface.html b/src/test/renderer/specs/interfaces/classes.nameinterface.html
@@ -136,11 +136,11 @@ <h3>name</h3>
 							<p>This is a interface member of INameInterface.</p>
 						</div>
 						<p>It should be inherited by all subinterfaces.</p>
-						<p>Links - these should all point to this property:</p>
+						<p>Links - these should all point to this property on the base class</p>
 						<ul>
 							<li><a href="classes.nameinterface.html#name">name</a></li>
 							<li><a href="classes.nameinterface.html#name">NameInterface.name</a></li>
-							<li>{@link &quot;classes&quot;.NameInterface.name}</li>
+							<li><a href="classes.nameinterface.html#name">classes.NameInterface.name</a></li>
 							<li><a href="classes.nameinterface.html#name">Text</a> &lt;-- This one goes away eventually</li>
 							<li><a href="classes.nameinterface.html#name">Text</a></li>
 							<li><a href="classes.nameinterface.html#name">Text</a></li>
diff --git a/src/test/renderer/specs/interfaces/classes.printnameinterface.html b/src/test/renderer/specs/interfaces/classes.printnameinterface.html
@@ -132,11 +132,11 @@ <h3>name</h3>
 							<p>This is a interface member of INameInterface.</p>
 						</div>
 						<p>It should be inherited by all subinterfaces.</p>
-						<p>Links - these should all point to this property:</p>
+						<p>Links - these should all point to this property on the base class</p>
 						<ul>
 							<li><a href="classes.printnameinterface.html#name">name</a></li>
 							<li><a href="classes.nameinterface.html#name">NameInterface.name</a></li>
-							<li>{@link &quot;classes&quot;.NameInterface.name}</li>
+							<li><a href="classes.nameinterface.html#name">classes.NameInterface.name</a></li>
 							<li><a href="classes.printnameinterface.html#name">Text</a> &lt;-- This one goes away eventually</li>
 							<li><a href="classes.printnameinterface.html#name">Text</a></li>
 							<li><a href="classes.printnameinterface.html#name">Text</a></li>

Original file line number	Diff line number	Diff line change
`@@ -16,10 +16,10 @@ export interface NameInterface {`
`16`	`16`	`*`
`17`	`17`	`* It should be inherited by all subinterfaces.`
`18`	`18`	`*`
`19`		`- * Links - these should all point to this property:`
	`19`	`+ * Links - these should all point to this property on the base class`
`20`	`20`	`* - {@link name}`
`21`	`21`	`* - {@link NameInterface.name}`
`22`		`- * - {@link "classes".NameInterface.name}`
	`22`	`+ * - {@link classes.NameInterface.name}`
`23`	`23`	`* - {@link name Text} <-- This one goes away eventually`
`24`	`24`	`* - {@link name\|Text}`
`25`	`25`	`* - {@link name \| Text}`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ export function copyComment(target: Reflection, source: Reflection) {`
`49`	`49`	`* TSDoc overrides existing parameters entirely with inherited ones, while`
`50`	`50`	`* existing implementation merges them.`
`51`	`51`	* To avoid breaking things, `inheritDoc` tag is additionally checked for the parameter,
`52`		`- * so the previous behaviour will continue to work.`
	`52`	`+ * so the previous behavior will continue to work.`
`53`	`53`	`*`
`54`	`54`	`* TODO: When breaking change becomes acceptable remove legacy implementation`
`55`	`55`	`*/`
`@@ -61,6 +61,15 @@ export function copyComment(target: Reflection, source: Reflection) {`
`61`	`61`	`}`
`62`	`62`	`target.comment.removeTags("inheritdoc");`
`63`	`63`	`target.comment.copyFrom(source.comment);`
	`64`	`+ } else if (!target.comment && source.comment) {`
	`65`	`+ if (`
	`66`	`+ target instanceof DeclarationReflection &&`
	`67`	`+ source instanceof DeclarationReflection`
	`68`	`+ ) {`
	`69`	`+ target.typeParameters = source.typeParameters;`
	`70`	`+ }`
	`71`	`+ target.comment = new Comment();`
	`72`	`+ target.comment.copyFrom(source.comment);`
`64`	`73`	`}`
`65`	`74`	`}`
`66`	`75`