You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
CompoDoc cannot create proper links to a class when the class name includes an interface name.
CompoDoc generates links to the interface instead of the class.
Angular configuration, a package.json file in the root folder
No Angular
No dependencies other than compodoc and typescript
We first found the problem in an Angular project.
After some works, we noticed that the problem could occur in bare NPM projects.
Compodoc installed globally or locally ?
Globally or locally.
If possible sourcecode of the file where it breaks
interfaceAa{}// The prefix of class name matches the interface nameclassAaBb{}// ^^// The intermediate of class name matches the interface nameclassBbAaCc{}// ^^// The suffix of class name matches the interface nameclassCcAa{}// ^^classContainer{// This type links to Aa interface, not AaBb class.a: AaBb;// This type links to Aa interface, not BbAaCc class.b: BbAaCc;// This type links to Aa interface, not CcAa class.c: CcAa;}
Reproduce the error
Define an interface
Define a class of which name includes the interface name
Create a property of which type is the class
Related issues
The problem seems similar to #157, which has been resolved.
The text was updated successfully, but these errors were encountered:
Overview of the issue
CompoDoc cannot create proper links to a
class
when the class name includes aninterface
name.CompoDoc generates links to the
interface
instead of theclass
.Operating System, Node.js, npm, compodoc version(s)
Angular configuration, a
package.json
file in the root foldercompodoc
andtypescript
We first found the problem in an Angular project.
After some works, we noticed that the problem could occur in bare NPM projects.
Compodoc installed globally or locally ?
Globally or locally.
If possible sourcecode of the file where it breaks
Reproduce the error
interface
class
of which name includes theinterface
nameclass
Related issues
The problem seems similar to #157, which has been resolved.
The text was updated successfully, but these errors were encountered: