Added support for Types and Interfaces. One can navigate to type/interface by clicking on it, it navigates to the proper page section and highlights the Type/Interface for a moment. Note that it works only for simple types, MyType or MyType[]. To support this, each page's route is now split into /example and /api.
To be able to retrieve the location of the Type/Interface in a constant time, I introduced types_map.json file that is generated together with other .json files. The file serves as a key-value mapping in which Type/Interface name is a key and its location is a value.
Future work (issues I'm aware of but might be a bit time-consuming to implement):
generate docs for classes (they are used as a type, e.g. CpsDialogConfig)
using custom Type in method params or method return types doesn’t work for some reason (might be a typedoc issue) as using Interface works
type typeof iconNames[number] is not handled properly
make links work not only for MyType or MyType[] but also for more complicated types, e.g. in type Record<string, MyType>, or in generic MyType<any>, we want to make MyType clickable if it is defined somewhere in the docs. Ideally, this should be parsed AOT to not affect runtime performance.
Added support for Types and Interfaces. One can navigate to type/interface by clicking on it, it navigates to the proper page section and highlights the Type/Interface for a moment. Note that it works only for simple types,
MyTypeorMyType[]. To support this, each page's route is now split into/exampleand/api.To be able to retrieve the location of the Type/Interface in a constant time, I introduced
types_map.jsonfile that is generated together with other .json files. The file serves as a key-value mapping in which Type/Interface name is a key and its location is a value.Future work (issues I'm aware of but might be a bit time-consuming to implement):
CpsDialogConfig)typedocissue) as using Interface workstypeof iconNames[number]is not handled properlyMyTypeorMyType[]but also for more complicated types, e.g. in typeRecord<string, MyType>, or in genericMyType<any>, we want to makeMyTypeclickable if it is defined somewhere in the docs. Ideally, this should be parsed AOT to not affect runtime performance.