Update or remove tsd-jsdoc
- Dominant language
- JavaScript
- Stars
- 15.7k
- Forks
- 3.9k
- Avg merge
- 4d 6h
- Merged PRs (30d)
- 34
Description
As part of the build process, [CesiumJS generates TypeScript definitions based off our jsdoc comments](https://github.com/CesiumGS/cesium/pull/8878).
While we're generally pretty meticulous about having accurate documentation, there are a few instances of invalid jsdoc that have slipped through. The `build-ts` scripts, which converts our jsdoc to TypeScript definitions, has recently been spitting out a ton of warnings indicating probable issues with our meta tags.
There is a helpful list of common pitfalls the link above, including:
> * Use proper `@enum` notation for enums.
> * Use proper `@namespace` notation for static classes.
> * Use proper `@function` notation for standalone functions.
> * Fix Promise markup to actually include the type in all cases, i.e. `Promise` => `Promise` or `Promise`.
This list likely covers most of the warnings. We should fix theses to ensure we have accurate documentation and accurate TYpeScript definitions.
Contributor guide
Assessment
This issue has not been assessed yet.