Skip to content

Commit 7fb2587

Browse files
committed
Update documentation for bit-docs.js
1 parent fe80c1d commit 7fb2587

File tree

1 file changed

+21
-4
lines changed

1 file changed

+21
-4
lines changed

bit-docs.js

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
var postProcessTags = require("./post-process");
2+
var processTags = require("./process-tags");
3+
var _ = require("lodash");
4+
15
/**
26
* @parent plugins
37
* @module {function} bit-docs-process-tags
@@ -8,11 +12,24 @@
812
*
913
* @body
1014
*
11-
* TBD
15+
* This plugin registers onto these hooks:
16+
* - `processor`
17+
* - `postProcessor`
18+
*
19+
* This plugin handles the `tags` hook, and in doing so also adds some tags:
20+
* - [bit-docs-process-tags/tags/add @add]
21+
* - [bit-docs-process-tags/tags/body @body]
22+
* - [bit-docs-process-tags/tags/description @description]
23+
* - [bit-docs-process-tags/tags/hide @hide]
24+
* - [bit-docs-process-tags/tags/parent @parent]
25+
*
26+
* Registering the `processor` hook adds a general processor that processes a
27+
* code comments and produces a [bit-docs/types/docObject] from the tags found.
28+
*
29+
* Registering the `postProcessor` hook adds a special processor that calls the
30+
* `done` method of any tags that have such a method, passing the
31+
* [bit-docs/types/docObject].
1232
*/
13-
var postProcessTags = require("./post-process");
14-
var processTags = require("./process-tags");
15-
var _ = require("lodash");
1633
module.exports = function(bitDocs){
1734
// this makes tags run
1835
bitDocs.register("postProcessor", postProcessTags);

0 commit comments

Comments
 (0)