canvas-ui-typedoc-resolver
Resolves TypeDoc third-party symbols to canvas-ui classes, interfaces, enums, etc... TypeDoc can't normally resolve these symbols, so this plugin manually resolves them so that there can be a more seamless (albeit imperfect) documentation.
Mostly only used for canvas-ui integration libraries such as:
Known issues
The resolver doesn't work for @link
tags
(issue). This is also
caused by @link
tags generated by canvas-ui being reintroduced into the
documentation due to extending a canvas-ui class; for example:
-
canvas-ui
defines a functionmyFunction
-
canvas-ui
defines a classMyClass
with a propertymyProperty
, where the property has a@link
tag tomyFunction
in its docstring -
canvas-ui-plugin
defines a classMyExtendedClass
which extendsMyClass
Despite myProperty
not being defined by the canvas-ui-plugin
library, it is
still included in the canvas-ui-plugin
documentation because it's part of
MyExtendedClass
, which has a @link
tag to canvas-ui
's myFunction
, which
creates a broken link and a warning.
Special thanks
Special thanks to Playko (website, github) where this project started and is currently being developed at.
License
This project is licensed under the MIT license (see the LICENSE file)
This project uses the following open-source projects:
- @types/node (DefinitelyTyped) licensed under the MIT license
- resolve-package-path licensed under the MIT license
- typedoc licensed under the Apache 2.0 license
- typescript licensed under the Apache 2.0 license