@@ -9,7 +9,8 @@ var path = require("path");
9
9
*
10
10
* @description Tags, templates, and basic styles for JavaScript.
11
11
*
12
- * @param {Object } [bitDocs] The configuration object passed by `bit-docs` at runtime.
12
+ * @param {Object } [bitDocs] The configuration object passed by `bit-docs` at
13
+ * runtime.
13
14
*
14
15
* @body
15
16
*
@@ -21,19 +22,19 @@ var path = require("path");
21
22
* Registering the `tag` hook adds JavaScript-related tags:
22
23
* - [bit-docs-js/tags/function @function]
23
24
* - [bit-docs-js/tags/param @param]
24
- * - [bit-docs-js/tags/signature @signature] (has mustache template)
25
+ * - [bit-docs-js/tags/signature @signature]
25
26
* - ...
26
27
*
27
28
* Registering the `processor` hook adds a processor for `*.js` files that gets
28
- * code comments in JavaScript, and processes tags like `@function` and `@param`
29
- * into docObjects that are subsequently added to the docMap. The processor is
30
- * also smart enough process regular comments above functions that have not
31
- * explicitly been documented with closure type annotations to extract basic
32
- * signature information such as parameters and return type.
29
+ * code comments in JavaScript, and processes tags like `@function` and
30
+ * `@param` into docObjects that are subsequently added to the docMap.
31
+ *
32
+ * The processor is also smart enough process regular comments above functions
33
+ * that have not explicitly been documented with closure type annotations, and
34
+ * extracts basic signature information such as parameters or return type.
33
35
*
34
- * Registering the `html` hook adds mustache templates used for generation of
35
- * HTML related to those tags added by this plugin. Currently it's one big
36
- * template used to nicely format all the tag information.
36
+ * Registering the `html` hook adds a mustache template used to generate the
37
+ * HTML for the tags added by this plugin.
37
38
*/
38
39
module . exports = function ( bitDocs ) {
39
40
// register your tags
0 commit comments