File tree Expand file tree Collapse file tree 1 file changed +21
-4
lines changed Expand file tree Collapse file tree 1 file changed +21
-4
lines changed Original file line number Diff line number Diff line change
1
+ var postProcessTags = require ( "./post-process" ) ;
2
+ var processTags = require ( "./process-tags" ) ;
3
+ var _ = require ( "lodash" ) ;
4
+
1
5
/**
2
6
* @parent plugins
3
7
* @module {function} bit-docs-process-tags
8
12
*
9
13
* @body
10
14
*
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].
12
32
*/
13
- var postProcessTags = require ( "./post-process" ) ;
14
- var processTags = require ( "./process-tags" ) ;
15
- var _ = require ( "lodash" ) ;
16
33
module . exports = function ( bitDocs ) {
17
34
// this makes tags run
18
35
bitDocs . register ( "postProcessor" , postProcessTags ) ;
You can’t perform that action at this time.
0 commit comments