jsdoc-plugin-abitbol
A jsdoc plugin which simplifies abitbol classes documentation.
Installation
Install jsdoc-plugin-abitbol
npm install --save-dev jsdoc-plugin-abitbol
Add an entry in the plugins
list of your jsdoc
config file :
Usage
Classes
/*** My class.** @class mynamespace.mymodule.MyClass* @extends Class* @param params * @emits myEvent*/const MyClass = Class
Modules
Direct export :
/** * My module. * * @exports mynamespace.mymodule */moduleexports = /** * My class instance. * * @type mynamespace.mymodule.MyClass */ myClass: null
For indirect export :
/** * My module. * * @exports mynamespace.mymodule */const myModule = /** * My class instance. * * @type mynamespace.mymodule.MyClass */ myClass: null moduleexports = 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