File tree Expand file tree Collapse file tree 1 file changed +9
-4
lines changed Expand file tree Collapse file tree 1 file changed +9
-4
lines changed Original file line number Diff line number Diff line change @@ -22,13 +22,18 @@ var path = require("path");
22
22
* - [bit-docs-js/tags/function @function]
23
23
* - [bit-docs-js/tags/param @param]
24
24
* - [bit-docs-js/tags/signature @signature] (has mustache template)
25
+ * - ...
25
26
*
26
27
* 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.
29
33
*
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.
32
37
*/
33
38
module . exports = function ( bitDocs ) {
34
39
// register your tags
You can’t perform that action at this time.
0 commit comments