jsdoc-parse

What is jsdoc-parse?

The jsdoc-parse npm package is a tool for parsing JSDoc comments in JavaScript files and generating JSON output. It is useful for extracting documentation information from code comments and can be integrated into documentation generation workflows.

What are jsdoc-parse's main functionalities?

Parsing JSDoc comments

This feature allows you to parse JSDoc comments from JavaScript code and generate a JSON representation of the documentation. The code sample demonstrates how to parse a simple JSDoc comment and output the parsed JSON.

const jsdocParse = require('jsdoc-parse');
const fs = require('fs');

const jsdocComments = `
/**
 * Adds two numbers together.
 * @param {number} a - The first number.
 * @param {number} b - The second number.
 * @returns {number} The sum of the two numbers.
 */
function add(a, b) {
  return a + b;
}
`;

jsdocParse({ src: jsdocComments }).then(output => {
  console.log(JSON.stringify(output, null, 2));
});

Generating JSON output

This feature allows you to generate JSON output from JSDoc comments and save it to a file. The code sample demonstrates how to parse JSDoc comments and write the resulting JSON to a file named 'output.json'.

const jsdocParse = require('jsdoc-parse');
const fs = require('fs');

const jsdocComments = `
/**
 * Multiplies two numbers together.
 * @param {number} a - The first number.
 * @param {number} b - The second number.
 * @returns {number} The product of the two numbers.
 */
function multiply(a, b) {
  return a * b;
}
`;

jsdocParse({ src: jsdocComments }).then(output => {
  fs.writeFileSync('output.json', JSON.stringify(output, null, 2));
});

Other packages similar to jsdoc-parse

documentation

The 'documentation' package is a documentation generation tool that supports JSDoc comments. It can generate HTML, Markdown, and JSON documentation from JavaScript code. Compared to jsdoc-parse, 'documentation' offers more output format options and additional features like linting and serving documentation as a web server.

jsdoc

The 'jsdoc' package is a popular tool for generating HTML documentation from JSDoc comments. It provides a wide range of configuration options and supports plugins for extending its functionality. While jsdoc-parse focuses on parsing and generating JSON output, 'jsdoc' is more comprehensive in terms of generating complete documentation websites.

esdoc

The 'esdoc' package is a documentation generator for JavaScript that supports ES6+ syntax. It provides features like coverage reports, test integration, and a plugin system. Compared to jsdoc-parse, 'esdoc' offers more advanced features and is tailored for modern JavaScript syntax.

README

#jsdoc-parse Exports a single function (parse) to parse jsdoc data.

Example

var parse = require("jsdoc-parse");

##Install

$ npm install -g jsdoc-parse

Mac / Linux users may need to run with sudo.

##API Reference ##parse(options) ⏏ Documented javascript source files in, doclet data out.

Params

• options object - options
  • [src] string | Array.<string> - source file(s) to parse
  • [private] boolean - include @private members in the output

Returns: Stream - a readable stream containing the parsed json data
Example

> parse({ src: "lib/jsdoc-parse.js" }).pipe(process.stdout);
[
  {
    "kind": "module",
    "name": "jsdoc-parse",
    "examples": [
      "```js\nvar parse = require(\"jsdoc-parse\");\n```"
    ],
    "longname": "module:jsdoc-parse"
  },
  {
    "description": "Documented javascript source files in, doclet data out.",
    "alias": "module:jsdoc-parse",
    "params": [
      {
        "type": {
          "names": [
            "object"
          ]
        },
        "description": "options",
        "name": "options"
      },
      {
        "type": {
          "names": [
            "string",
            "Array.<string>"
          ]
        },
        "optional": true,
        "description": "source file(s) to parse",
        "name": "options.src"
      },
      {
        "type": {
          "names": [
            "boolean"
          ]
        },
        "optional": true,
        "description": "include @private members in the output",
        "name": "options.private"
      }
    ],
    "returns": [
      {
        "type": {
          "names": [
            "Stream"
          ]
        },
        "description": "a readable stream containing the parsed json data"
      }
    ],
    "examples": [
      "```js\nparse({ src: \"lib/jsdoc-parse.js\" }).pipe(process.stdout);\n```"
    ],
    "name": "module:jsdoc-parse",
    "longname": "module:jsdoc-parse",
    "kind": "function",
    "codeName": "parse"
  },
  {
    "files": [
      "/Users/Lloyd/Documents/75lb/jsdoc-parse/lib/jsdoc-parse.js"
    ],
    "kind": "package",
    "longname": "package:undefined"
  }
]

documented by jsdoc-to-markdown