Skip to content

Commit 04a3b42

Browse files
committed
prelim docs
1 parent ffada3c commit 04a3b42

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

bit-docs.js

+12
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
var pkg = require("./package");
22

3+
/**
4+
* @module {function} bit-docs-tag-package
5+
* @parent plugins
6+
*
7+
* @description Adds a `@package` tag for use in `bit-docs`.
8+
*
9+
* @body
10+
*
11+
* `@package` will add the package's `package.json` info to the `docObject`.
12+
*
13+
* Use: `@pacakge ../../package.json`
14+
*/
315
module.exports = function(bitDocs) {
416
bitDocs.register("tags",{
517
package: pkg

0 commit comments

Comments
 (0)