Skip to content

Commit 428521b

Browse files
committed
expound overview docs on main export
1 parent 45b19d1 commit 428521b

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

bit-docs.js

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,18 @@ var path = require("path");
2222
* - [bit-docs-js/tags/function @function]
2323
* - [bit-docs-js/tags/param @param]
2424
* - [bit-docs-js/tags/signature @signature] (has mustache template)
25+
* - ...
2526
*
2627
* Registering the `processor` hook adds a processor for `*.js` files that gets
27-
* code comments in JavaScript files and processes them, parsing tags like
28-
* `@function` and `@param` into docObjects added to the docMap.
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.
2933
*
30-
* Registering the `html` hook adds mustache templates used for generating the
31-
* HTML related to those tags added by this plugin.
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.
3237
*/
3338
module.exports = function(bitDocs){
3439
// register your tags

0 commit comments

Comments
 (0)