jsdoc
jsdoc copied to clipboard
jsdoc
An API documentation generator for JavaScript.
Instead of rendering something like `new module:foo/bar()` for a constructor aliased as a module in the default template, we can treat it like an exposed function and render: `new (require("foo/bar"))()`....
### JSDoc code [jsdoc/tag/type.js](https://github.com/jsdoc/jsdoc/blob/4.0.2/lib/jsdoc/tag/type.js#L153) [jsdoc/util/cast.js](https://github.com/jsdoc/jsdoc/blob/4.0.2/lib/jsdoc/util/cast.js#L72) ```js function parseName(tagInfo) { // like '[foo]' or '[ foo ]' or '[foo=bar]' or '[ foo=bar ]' or '[ foo = bar ]' // or...
JS doesn't have a distinct int/Integer/int32 type but it would be really helpful and can prevent from many errors. Same for float/double/float32. In the same time JS has Int8Array/Uint8Array which...
**Note:** This is how JetBrains' PHPStorm IDE documents arrays of values of unknown type by default. ### Input code ```js /** * @param {*[]} foo */ ``` ### JSDoc configuration...
When using the markdown plugin, method summaries that do not end in a period get one added *after* the closing paragraph tag. ### Input code ```js /** * Get the...
I would need to tag when a function has side effects, say with: ``` @sideEffects: console.log, fs.writefile ``` ### Expected behavior This is supposed to be an array of strings...
Would love JSDoc support for defining a valid range of numbers. Like this (syntax is made up): ``` /** * Get the number of days in a month. * @param...
I didn't find any configurations for this, is it possible that jsdoc doesn't provide this function?
When parsing a function doc comment JSDoc alters the line breaks in the "description" section on Windows 10 (likely on other Windows versions too) ### Input code ``` /** *...
### Used by - [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped) - [Commander](https://github.com/tj/commander.js) - [Express](https://github.com/expressjs/express) - [AWS SDK](https://github.com/aws/aws-sdk-js) - [SuperAgent](https://github.com/ladjs/superagent) - [Engine.IO](https://github.com/socketio/engine.io) - [Stylus](https://github.com/stylus/stylus) - [Mongoose](https://github.com/Automattic/mongoose) - [PM2](https://github.com/Unitech/pm2) - And [more…](https://github.com/search?q=%22*+%40api+private%22+path%3A%2F%5C.%28js%7Cts%29x%3F%24%2F+NOT+is%3Afork&type=code) ### Current support - [Dox](https://github.com/tj/dox)...
