Nimble Polyglot Microcosm

    @terraswarm/jsdoc

    3.5.1-dev • Public • Published

    JSDoc 3 with Accessor Extensions

    This is a fork of JSDoc 3 that supports the @accessor tag

    See https://www.terraswarm.org/accessors/wiki/Main/JSDoc

    The sources are at https://www.terraswarm.org/accessors/wiki/Main/JSDoc

    How to publish

    1. Update the patch number in package.json

    2. Login to npm npm login

      Username: terraswarm
      Password: See ~terra/.npmpass on terra
      Email: terraswarm-software@terraswarm.org 
      
    3. Publish: npm publish --access public

    Below is the original README.md from JSDoc3.

    JSDoc 3

    Build Status

    An API documentation generator for JavaScript.

    Want to contribute to JSDoc? Please read CONTRIBUTING.md.

    Installation and Usage

    JSDoc supports Node.js 0.10 and later. You can install JSDoc in your project's node_modules folder, or you can install it globally.

    To install the latest version available on NPM:

    npm install jsdoc
    

    To install the latest development version:

    npm install git+https://github.com/jsdoc3/jsdoc.git
    

    If you installed JSDoc locally, the JSDoc command-line tool is available in ./node_modules/.bin. To generate documentation for the file yourJavaScriptFile.js:

    ./node_modules/.bin/jsdoc yourJavaScriptFile.js
    

    Or if you installed JSDoc globally, simply run the jsdoc command:

    jsdoc yourJavaScriptFile.js
    

    By default, the generated documentation is saved in a directory named out. You can use the --destination (-d) option to specify another directory.

    Run jsdoc --help for a complete list of command-line options.

    Templates and Build Tools

    The JSDoc community has created numerous templates and other tools to help you generate and customize your documentation. Here are just a few:

    Templates

    Build Tools

    For More Information

    License

    JSDoc 3 is copyright (c) 2011-present Michael Mathews micmath@gmail.com and the contributors to JSDoc.

    JSDoc 3 is free software, licensed under the Apache License, Version 2.0. See the file LICENSE.md in this distribution for more details.

    Install

    npm i @terraswarm/jsdoc

    DownloadsWeekly Downloads

    2

    Version

    3.5.1-dev

    License

    Apache-2.0

    Unpacked Size

    1.51 MB

    Total Files

    125

    Last publish

    Collaborators

    • terraswarm