@inheritdoc is not working

[rochdev]

I've seen multiple mentions that this feature is supposedly supported, but it doesn't seem to be working.

For example:

declare class Tracer extends opentracing.Tracer {
  /** @inheritdoc */
  inject(spanContext: SpanContext | Span, format: string, carrier: any): void;
}

If I don't override the method the documentation is properly displayed.

[aciccarello]

Hello @rochdev. There are a few known issues with @inheritdoc at the moment. Does the method you are overriding differ at all in its type signature? If so, this might be the same as #793. If no, could you please provide more information about how we can reproduce this?

[rochdev]

@aciccarello It differs only in that Span is a subclass of opentracing.Span whereas the original expect opentracing.Span. This also applies to SpanContext. Since it's a subclass I would however not expect this to be the cause.

The library that is extended is https://github.com/opentracing/opentracing-javascript

index.d.ts

declare class Tracer extends opentracing.Tracer {
  /** @inheritdoc */
  inject(spanContext: SpanContext | Span, format: string, carrier: any): void;
}

tsconfig.json

{
 "compilerOptions": {
   "moduleResolution": "node",
   "module": "commonjs",
   "baseUrl": "."
 },
 "include": [
   "index.d.ts"
 ]
}

typedoc.js

'use strict'

module.exports = {
 excludeExternals: true,
 excludePrivate: true,
 excludeProtected: true,
 includeDeclarations: true,
 mode: 'file',
 name: 'dd-trace',
 out: 'docs',
 readme: 'README.md'
}

[rochdev]

@aciccarello Just tried with the exact same types (no subclass) and it's still not working.

[rochdev]

FWIW it doesn't seem to work for the class documentation either. I don't know if it's the same issue, or if it's simply not implemented for the class description.

[benrr101]

I hate to necrobump this issue, but this is one I've been running into on my project (https://github.com/benrr101/node-taglib-sharp). I have classes (eg. Id3v1Tag) that inherits from an abstract class (Tag) that has a lot of long comments for properties I'd like to copy over using inheritDoc. While fiddling with syntax to see if I was just doing it wrong, I noticed my classes that inherited from an interface copied over correctly (eg, ApeStreamHeader inheriting from ICodec). Is it possible the inheritDoc functionality just isn't working with abstract class inheritance?

This could totally be a different issue, if so, let me know and I'll make a new issue from this.

[Gerrit0]

That might be the case... however I also might have fixed this in recent work done on v0.20.

With these changes:

diff --git a/src/id3v1/id3v1Tag.ts b/src/id3v1/id3v1Tag.ts
index 7fd0154..f053c78 100644
--- a/src/id3v1/id3v1Tag.ts
+++ b/src/id3v1/id3v1Tag.ts
@@ -122,13 +122,8 @@ export default class Id3v1Tag extends Tag {
      */
     public set performers(value: string[]) { this._artist = value ? value.join(";") : ""; }

-    /** @inheritDoc */
+    /** @inheritdoc */
     public get album(): string { return this._album || undefined; }
-    /**
-     * @inheritDoc
-     * @description When stored on disk, only the first 30 bytes of the latin-1 encoded value will
-     *     be stored. This may result in data loss.
-     */
     public set album(value: string) { this._album = value ? value.trim() : ""; }

     /** @inheritDoc */

diff --git a/tsconfig.json b/tsconfig.json
index ac5cf56..bc08008 100644
--- a/tsconfig.json
+++ b/tsconfig.json
@@ -17,11 +17,11 @@
     "./src/**/*"
   ],
   "typedocOptions": {
-    "inputFiles": ["./src"],
+    "entryPoints": ["./src/index.ts"],
     "mode": "modules",
     "out": "docs/",
     "excludePrivate": true,
     "disableSources": true,
     "listInvalidSymbolLinks": true
   }
-}
\ No newline at end of file
+}

diff --git a/package.json b/package.json
index 502b7b9..e48d86a 100644
--- a/package.json
+++ b/package.json
@@ -46,7 +46,7 @@
     "tslint": "^5.13.1",
     "typemoq": "^2.1.0",
     "typescript": "^3.9.7",
-    "typedoc": "^0.19.2",
+    "typedoc": "0.20.0-beta.10",
     "typedoc-plugin-markdown": "^3.0.11",
     "uuid": "^7.0.2"
   }

I ran npx typedoc --plugin none (typedoc-plugin-markdown doesn't work with 0.20 yet) and it generated this page:

[benrr101]

Well hot damn, that's great to see! I guess I'll just hang on a bit longer until typedoc-plugin-markdown supports 0.20 (or I get annoyed with markdown and just start hosting the docs as html somewhere else).

Out of curiosity, what was the reason for removing the tsdoc for the set accessor?

[Gerrit0]

There was a bug in the accessor converter that broke things if the set accessor had comments - now fixed, but I didn't realize it when first looking at this issue.