‚̧Needlessly Postulating Minds
    Have ideas to improve npm?Join in the discussion! ¬Ľ

    jsdoc-plugin-false-booleans

    1.0.0¬†‚Äʬ†Public¬†‚Äʬ†Published

    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
    

    and add to the list of plugins in your JSDoc configuration file:

    {
        "plugins": ["./node_modules/jsdoc-plugin-named-defaults/false-booleans.js"]
    }
    

    Example

    /**
    * @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.

    Install

    npm i jsdoc-plugin-false-booleans

    DownloadsWeekly Downloads

    1

    Version

    1.0.0

    License

    MIT

    Last publish

    Collaborators

    • avatar