bit-docs-js module

Plugin to process .js files and help document JavaScript code.

Use this plugin

Add this plugin to your project package.json:

  "name": "my-project",
  "bit-docs": {
    "dependencies": {
      "bit-docs-js": "*",

Once added, this plugin allows you to document .js files like:

 * @module {{}} example/settings settings
 * @parent example
 * @option {String} environment Production, development, or staging.
 * @option {Number} requestTimeout How long to wait between requests.
export default {
    environment: "production",
    requestTimeout: 100

Using signature.mustache in the default theme, this example renders like:

See next