jsdoc
jsdoc copied to clipboard
jsdoc
An API documentation generator for JavaScript.
JSDoc does not have a good way to describe "theory of operation". Types? Yes. APIs? Sort of. Conceptual explanations? Not really. The closest thing seems to be abusing modules. There...
When generating documentation for a class that extends another, and the base class has it's constructor documented, JSDoc generates duplicated documentation pages for the class that is being extended. ###...
I know I can constrain a parameter to one of items in a list: ```javascript /** @typedef {'a'|'b'|'c'} Alphabet */ /** @param {Alphabet} s */ function write(s) { // s...
When documenting code with an '@' symbol in the `@example` block, jsdoc thinks the '@' is a tag and breaks the rendering of the example code ### Input code ```js...
Hi, I see that the tags [@abstract](https://jsdoc.app/tags-abstract) and [@override](https://jsdoc.app/tags-override) exist, however, to complete them, we may think about a `@sealed` tag. The purpose of this tag would be to indicate...
I want to document a class that returns another class depending on the input. I have created some code that will wrap a class onto an html element created during...
### Input code ```js /** * Canvas * * @class Canvas */ class Canvas { /** * Creates an instance of Canvas. * @returns {HTMLCanvasElement} * @memberof Canvas */ constructor(width,...
### Expected behavior using the @enum tag implies an object where key values represent basic value types - number, string, boolean, or something of the sort. The value associated with...
I've not found any documentation about how curried functions should be documented. Lets asume we have the following function: ``` js const push = browserHistory => route => browserHistory.push(route) ```...
I have nuxtjs app with a vue component that I want to document. This behavior only happens in my nuxtjs app. All my vue apps documentation work fine. The complete...
