jsdoc
jsdoc copied to clipboard
An API documentation generator for JavaScript.
JSDoc does not generate documentation for functions and classes exported as default ES module export
### Input code File functions.js ```js /** * Example function, default export. * @param {string} arg - String to print. */ export default function foo(arg) {} ``` File classes.js ```js...
  
Javascript in ES modules with a .mjs file extension are not supported by jsdoc. This is the new extension that's going to be promoted by NodeJS, and already supported by...
It's usual to have places where you only can set a group of strings, for example names of events or types of media, and don't want to allow others. At...
JSDoc fails while parsing the code I've shown below. ### Input code ```js class ParentClass { /** * Documentation */ static InnerClass = class { } } ``` ### JSDoc...
### Input code ```js /** * Test function. * @param {string} [arg] - Test argument. */ export function test(arg = 'default_value') {} ``` ### JSDoc configuration Default. ### JSDoc debug...
When generating documentation for the code snippet below, the "Classes" menu on the right shows "exports" instead of "Car". Also, it shows "new exports()" instead of "new Car()" on its...
Not an issue but more a feature request. Feels free to close this if you think that it must not belong there. ## Context & problem I figured out that,...
[](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` -> `>=...
### Input code There's a `@const` tag supported by Closure for marking a variable or class property (or alias?) as read-only. I'm looking for a similar syntax that can be...