jsdoc
jsdoc copied to clipboard
An API documentation generator for JavaScript.
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [eslint](https://eslint.org) ([source](https://togithub.com/eslint/eslint)) | [`>= 8.57.0` -> `>=...
JSDoc allows you to use literals, including numbers for type definitions, such as when a function only works on a certain domain: `/** @param foo {(1|2|"banana")} */` However, unlike JS...
| Q | A | | ---------------- | ---------------------------------------------------------------- | | Bug fix? | yes | | New feature? | no | | Breaking change? | no | | Deprecations?...
| Q | A | | ---------------- | ---------------------------------------------------------------- | | Bug fix? | yes/no | | New feature? | yes/no | | Breaking change? | yes/no | | Deprecations?...
### Input code https://github.com/daniel-lewis-ab/litegraph.js/tree/startingAgain For this repo, I've been trying to use JSDocs to document src as per package.json ### JSDoc debug output ``` npm run docs > [email protected] docs...
# Enum values are not generated I have the following enum in `enums.ts` Only the enum type name is getting generated , but not the values. How can I have...
Since many bugs are caused by recent changes, there should be a way to document a change inline. For example, //@change: { by:userId, utcTime: new Date().toUTCString()} PS If you need...
The `summary` tag produces nested paragraphs in HTML https://github.com/jsdoc/jsdoc/blob/4a65306ded53d19a555545f699cfaa9d54c782fb/packages/jsdoc-template-legacy/tmpl/members.tmpl#L24 https://github.com/jsdoc/jsdoc/blob/4a65306ded53d19a555545f699cfaa9d54c782fb/packages/jsdoc-template-legacy/tmpl/method.tmpl#L32
Just a thought on enhancement. Maybe the time has come to add some formal tag that marks the code fragments generated by AI? ```js /** * // ... * @generated...
Auto-explanatory issue. Link: https://github.com/jsdoc/jsdoc/blob/main/conf.json.EXAMPLE Doc reference: https://jsdoc.app/about-configuring-jsdoc