# jsdoc-plugin-abitbol

> A jsdoc plugin which simplifies abitbol classes documentation.

Latest version **0.1.5** (published 2018-08-10) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install jsdoc-plugin-abitbol
pnpm add jsdoc-plugin-abitbol
yarn add jsdoc-plugin-abitbol
bun add jsdoc-plugin-abitbol
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.5 |
| Published | 2018-08-10 |
| First published | 2017-02-10 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Wanadev |
| Maintainers | risq, wanadev |
| Keywords | jsdoc, abitbol |

## Links

- npm: https://www.npmjs.com/package/jsdoc-plugin-abitbol
- Repository: https://github.com/wanadev/jsdoc-plugin-abitbol
- Homepage: https://github.com/wanadev/jsdoc-plugin-abitbol#readme
- Issues: https://github.com/wanadev/jsdoc-plugin-abitbol/issues
- npm.io page: https://npm.io/package/jsdoc-plugin-abitbol

## Recent versions

- 0.1.5 (latest) — 2018-08-10
- 0.1.4 — 2017-02-15
- 0.1.3 — 2017-02-13
- 0.1.1 — 2017-02-13
- 0.1.0 — 2017-02-10

## README

# jsdoc-plugin-abitbol
[![npm version](https://badge.fury.io/js/jsdoc-plugin-abitbol.svg)](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

---
_Source: https://npm.io/package/jsdoc-plugin-abitbol · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._