Node's Play Mate

    javadoc2json

    1.0.6 • Public • Published

    javadoc2json

    The javadoc2json is a simple tool to generate code documentation from Javadoc comments of a project, and output a JSON file from them, by API or CLI.

    1. Installation

    For the API:

    ~$ npm install javadoc2json

    For the CLI:

    ~$ npm install -g javadoc2json

    2. Usage

    For the API:

    This is a complete example of the API of javadoc2json.

    var docs = require("javadoc2json").generate({
      include: [__dirname + "/**/*js"], // include all javascript files
      exclude: ["**/node_modules/**/*"], // exclude node_modules folders
      output: [__dirname + "/documentation.json"] // dump the documentation at this file
    });

    For the CLI:

    This is a complete example of the CLI (in 1 line):

    ~$ javadoc2json

     --output "docs/docs.json" 
    
     --include "**/*.js" "**/*.ts" 
    
     --exclude "*node_modules*/*" "**/bin/**/*" 
    

    Or its abbreviated equivalence:

    ~$ javadoc2json

      -o "docs/docs.json" 
    
      -i "**/*.js" "**/*.ts" 
    
      -x "*node_modules*/*" "**/bin/**/*" 
    

    See that one can pass multiple "include" or "exclude" patterns.

    3. CLI tool

    Commands

    Options:
      --help         Show help                                             [boolean]
      --version      Show version number                                   [boolean]
      --include, -i  Include a new glob pattern (as input)     [array] [default: []]
      --exclude, -x  Exclude a new glob pattern (as input)     [array] [default: []]
      --output, -o   Output JSON file                                       [string]
    

    4. API tool

    Methods

    generate(options)

    Returns: {Array<Object>} The generated JSON from the JavaDoc comments found.

    Description: This method generates a JSON file from the specified files, which are read and their path. Also, it returns the data generated.

    options

    Type:{Object}

    Default value:

    {
      include: ["**/*.js"],
      exclude: ["**/node_modules/**/*"],
      output: false
    }

    Description: All the options for the javadoc2json documentation generator. This object can have:

    - include: {Array<String>} or {String}Optional. List of glob patterns to be included in our documentation generation process.

    - exclude: {Array<String>} or {String} Optional. List of glob patterns to be excluded.

    - output: {Array<String>} or {String} Optional. List of files to dump the generated documentation (JSON).

    4. Conclusion

    Simple and powerful module to generate and manage the documentation of a project.

    Install

    npm i javadoc2json

    DownloadsWeekly Downloads

    1

    Version

    1.0.6

    License

    ISC

    Unpacked Size

    11.9 kB

    Total Files

    8

    Last publish

    Collaborators

    • allnulled