https://github.com/zandaqo/jsdoc-plugin-false-booleans
A plugin for JSDoc to set the default values of boolean params to false by default.
https://github.com/zandaqo/jsdoc-plugin-false-booleans
Last synced: about 1 year ago
JSON representation
A plugin for JSDoc to set the default values of boolean params to false by default.
- Host: GitHub
- URL: https://github.com/zandaqo/jsdoc-plugin-false-booleans
- Owner: zandaqo
- License: mit
- Created: 2016-01-15T14:02:28.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-05-19T13:13:51.000Z (about 8 years ago)
- Last Synced: 2025-03-15T00:10:04.995Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 2.93 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
This plugin for JSDoc 3 sets the default values of boolean params to `false` unless another value is specified in the comments.
# Install
```
npm i jsdoc-plugin-false-booleans -D
```
and add to the list of plugins in your JSDoc configuration file:
```
{
"plugins": ["./node_modules/jsdoc-plugin-false-booleans/false-booleans.js"]
}
```
# Example
```javascript
/**
* @param {boolean} [later] whether to do start doing stuff a bit later
* @param {boolean} [async] whether to do stuff asynchronously
*/
function doStuff(later, async) {
}
```
the plugin will set `false` as the default value for both `later` and `async` params in the resulting documentation.