bit-docs-js module

Tags, templates, and basic styles for JavaScript.

function(bitDocs)

Parameters

  1. bitDocs {Object}:

    The configuration object passed by bit-docs at runtime.

Returns

{undefined}:

This plugin registers onto these hooks:

  • tags
  • processor
  • html

Registering the tags hook adds JavaScript-related tags:

Registering the processor hook adds a processor for *.js files that gets code comments in JavaScript, and processes tags like @function and @param into DocObjects that are subsequently added to the DocMap.

The processor is also smart enough process regular comments above functions that have not explicitly been documented with closure type annotations, and extracts basic signature information such as parameters and/or return type.

Registering the html hook adds a mustache template used to generate the HTML for the tags added by this plugin.