bit-docs-js/bit-docs module

Register hooks to add tags, templates, and basic styles useful for documenting JavaScript.

jsPlugin(bitDocs)

Parameters

  1. bitDocs {Object}:

    Configuration object with a register method.

Use

Registers onto these hooks:

  • tags
  • processor
  • html

Tags

Registering the tags hook adds JavaScript-related tags:

Processor

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.

Comments above functions that do not include [bit-docs-js/types/tag]s will still be processed as [bit-docs-js/types/tagBlock]s as the processor extracts basic signature information such as parameters and/or return type from the CodeLine.

HTML

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