https://github.com/wanadev/jsdoc-plugin-abitbol
A jsdoc plugin which simplifies abitbol classes documentation.
https://github.com/wanadev/jsdoc-plugin-abitbol
Last synced: about 2 months ago
JSON representation
A jsdoc plugin which simplifies abitbol classes documentation.
- Host: GitHub
- URL: https://github.com/wanadev/jsdoc-plugin-abitbol
- Owner: wanadev
- License: bsd-3-clause
- Created: 2017-02-10T15:47:17.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-08-10T15:44:05.000Z (over 6 years ago)
- Last Synced: 2025-02-23T23:47:09.452Z (2 months ago)
- Language: JavaScript
- Homepage:
- Size: 13.7 KB
- Stars: 1
- Watchers: 8
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jsdoc-plugin-abitbol
[](https://www.npmjs.com/package/jsdoc-plugin-abitbol)
A [jsdoc](https://github.com/jsdoc3/jsdoc) plugin which simplifies [abitbol](https://github.com/wanadev/abitbol) classes documentation.
## Installation
Install `jsdoc-plugin-abitbol`
```shell
npm install --save-dev jsdoc-plugin-abitbol
```
Add an entry in the `plugins` list of your `jsdoc` config file :
```json
{
"plugins": ["node_modules/jsdoc-plugin-abitbol"]
}
```
## Usage
### Classes
```js
/**
* My class.
*
* @class mynamespace.mymodule.MyClass
* @extends Class
* @param params {Object} The parameters.
* @emits myEvent
*/
const MyClass = Class.$extend({
/**
* My event.
*
* @event myEvent
* @type {object}
* @property {boolean} The property.
*/
__init__(params) {
// ...
},
/**
* The name.
*
* @member {String} name
* @default null
*/
getName() {
// ...
},
setName(name) {
// ...
},
/**
* My method.
*
* @param {Object} params The parameters.
* @return {String} The result.
*/
method1(params) {
// ...
},
}
```
### Modules
Direct export :
```js
/**
* My module.
*
* @exports mynamespace.mymodule
*/
module.exports = {
/**
* My class instance.
*
* @type mynamespace.mymodule.MyClass
*/
myClass: null,
}
```
For indirect export :
```js
/**
* My module.
*
* @exports mynamespace.mymodule
*/
const myModule = {
/**
* My class instance.
*
* @type mynamespace.mymodule.MyClass
*/
myClass: null,
}
module.exports = myModule;
```
## Changelog
- **0.1.4**: Handle numbers in member names and type definition for member tags
- **0.1.3**: Fixes a comment insertion bug
- **0.1.2**: Supports event tags
- **0.1.1**: Updates documentation
- **0.1.0**: Initial release