Skip to content

[Task]: Make API doc compiling work with Typescript files #305

@GreenImp

Description

@GreenImp

Now that the source files have been converted to Typescript, the API doc building script no longer works, as it is not TS compatible out of the box.
It looks like it's possible to get it working: https://vuepress-jsdoc-example.vercel.app/code/#typescript

We also need to ensure that the API docs still contain the correct information, and also see if we can remove doc blocks, or at least some of the information from them, and infer it from the TS code.

  • Get API doc compiling working with TS
  • Look into removing doc blocks / modifying them to reduce code bloat

Metadata

Metadata

Assignees

Type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions