Skip to content

Commit fa17b49

Browse files
committed
improve overview docs on main export
1 parent 428521b commit fa17b49

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

bit-docs.js

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ var path = require("path");
99
*
1010
* @description Tags, templates, and basic styles for JavaScript.
1111
*
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.
1314
*
1415
* @body
1516
*
@@ -21,19 +22,19 @@ var path = require("path");
2122
* Registering the `tag` hook adds JavaScript-related tags:
2223
* - [bit-docs-js/tags/function @function]
2324
* - [bit-docs-js/tags/param @param]
24-
* - [bit-docs-js/tags/signature @signature] (has mustache template)
25+
* - [bit-docs-js/tags/signature @signature]
2526
* - ...
2627
*
2728
* 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.
3335
*
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.
3738
*/
3839
module.exports = function(bitDocs){
3940
// register your tags

0 commit comments

Comments
 (0)