Numerous Problems Multiplied

    jsdoc-plugin-abitbol

    0.1.5 • Public • Published

    jsdoc-plugin-abitbol

    npm version

    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 :

    {
        "plugins": ["node_modules/jsdoc-plugin-abitbol"]
    }

    Usage

    Classes

    /**
    * 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 :

    /**
     * My module.
     *
     * @exports mynamespace.mymodule
     */
    module.exports = {
        /**
         * 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,
    }
     
    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

    Keywords

    Install

    npm i jsdoc-plugin-abitbol

    DownloadsWeekly Downloads

    17

    Version

    0.1.5

    License

    BSD-3-Clause

    Unpacked Size

    4.61 kB

    Total Files

    4

    Last publish

    Collaborators

    • risq
    • wanadev