starting to document

Author: leoj3n

bit-docs.js

@@ -5,12 +5,18 @@ var path = require("path");
 /**
  * @module {function} bit-docs-js
  * @parent plugins
+ * @group bit-docs-js/tags
  *
  * @description A collection of tags, templates, and basic styles for JavaScript applications.
  *
+ * @param {Object} [bitDocs] The configuration object passed by `bit-docs` at runtime. 
+ * 
  * @body
  *
- * TBD
+ * This plugin registers onto these hooks:
+ *   - tags
+ *   - processor
+ *   - html
  */
 module.exports = function(bitDocs){
     // register your tags

tags/function.js

@@ -12,11 +12,11 @@ var getParent = require("bit-docs-process-tags/get-parent"),
 	var updateNameWithScope = require("../lib/updateNameAndParentWithScope");
 
 	/**
-	 * @constructor documentjs.tags.function @function
+	 * @module {Object} bit-docs-js/tags/function @function
 	 *
-	 * @parent documentjs.tags
+	 * @parent bit-docs-js/tags
 	 *
-	 * @description Specifies the comment is for a function. Use [documentjs.tags.param @param] to
+	 * @description Specifies the comment is for a function. Use [bit-docs-js/tags/param @param] to
 	 * specify the arguments of a function.
 	 *
 	 * @signature `@function [NAME] [TITLE]`