TypeDoc reports wrong class as parent class

[benmccann]

• I have checked issues with bug label and found no duplicates

Expected Behavior

Should correctly determine parent class.

Actual Behavior

Says:

Overrides BubbleController.constructor
Defined in controllers/controller.line.js:27

When it should say

Overrides DatasetController.constructor
Defined in controllers/controller.line.js:27

Here's the code: https://github.com/chartjs/Chart.js/blob/7397a41fac0e9a57c969148eddc2805c8b249ee7/src/controllers/controller.line.js#L27

Steps to reproduce the bug

git clone [email protected]:chartjs/Chart.js.git
cd Chart.js
git reset --hard 7397a41fac0e9a57c969148eddc2805c8b249ee7
npm install
npx typedoc

Now open:
file:///directoryWhereYouCheckedOutTheCode/Chart.js/dist/docs/typedoc/classes/_controllers_controller_line_.linecontroller.html

Environment

• Typedoc version: 0.16.9
• Node.js version: 12.13.1
• OS: Ubuntu

[Gerrit0]

That's... really weird. The hierarchy is correct, so TypeDoc did know what the parent class was, but copied in methods from a child class, which doesn't make sense.

Looks like this is only set in mergeDeclarations, so it must be called inappropriately somewhere. I'll take a closer look next weekend.

typedoc/src/lib/converter/factories/declaration.ts

Line 214 in d18664d

function mergeDeclarations(context: Context, reflection: DeclarationReflection, node: ts.Node, kind: ReflectionKind) {

[CoreyDotCom]

This issue still persists in latest TypeDoc... any workarounds??

[CoreyDotCom]

cc @Gerrit0 FWIW this was working fine in version 0.15.6 it seems. Can't use that version due to it depending on an older typescript though. Tested further and broke between 0.15.8 and 0.16.0-0.

[Gerrit0]

So... I've fixed this, for TypeScript projects. Unfortunately, it appears that work done to fix some other issues with inheritance breaks running TypeDoc on Chart.js entirely since we don't have special casing for all of the JSDoc style types. I'm sorry to say that I don't plan on fixing this - at least initially for 0.20. I'd like to support JS projects too, but the primary focus of TypeDoc is TypeScript projects.

For this to be supported:

• Add a special case to convertTypeAlias in src/lib/converter/symbols.ts for JSDocTypedef nodes
• Probably also add a bunch of type converters to src/lib/converter/types.ts for JSDoc type nodes

[donmccurdy]

@Gerrit0 I've been tracking this issue because it appears to be affecting my (TypeScript) project. Are you saying that this bug is specific to JS projects? Or that it was affecting all projects, but has since been fixed for TS projects and not JS projects? If the latter, what version of typedoc should the fix be available in? Thanks!

[Gerrit0]

It was affecting all projects, but 0.20 contains a fix for TS projects. It likely also fixes the issue in JS projects, but I was unable to confirm this with the Chart.js test case since it uses JSDoc style types. 0.20 is released as a beta now, and will be released fully before the end of the year.

[Gerrit0]

I just double checked, and confirmed that this is fixed in 0.20.9 for Chart.js

[benmccann]

That's awesome! Thanks for the amazing 0.20 release and all your help!!