Merge pull request #24 from bit-docs/docs

Update docs

Author: leoj3n

.gitignore

@@ -1,2 +1,3 @@
+package-lock.json
 node_modules/
 temp/

bit-docs.js

@@ -1,14 +1,23 @@
 var tags = require("./tags");
 
 /**
- * @module {function} bit-docs-html-toc
  * @parent plugins
+ * @module {function} bit-docs-html-toc
+ * @group bit-docs-html-toc/tags tags
+ * @group bit-docs-html-toc/static static
  *
  * @description Injects a table of contents for the page into an HTML element.
  *
  * @body
  *
- * TBD
+ * This plugin registers onto these hooks:
+ *   - `tags`
+ *   - `html`
+ *
+ * Registering the `tags` hook adds the [bit-docs-html-toc/tags/outline] tag.
+ * 
+ * Registering the `html` hook adds a static JavaScript file used to hydrate
+ * the table of contents [bit-docs-html-toc/toc.js].
  */
 module.exports = function(bitDocs) {
 	var pkg = require("./package.json");

tags.js

@@ -1,36 +1,34 @@
 /**
- * @constructor documentjs.tags.outline @outline
- * @parent documentjs.tags
+ * @parent bit-docs-html-toc/tags
+ * @module {bit-docs-process-tags/types/tag} bit-docs-html-toc/tags/outline @outline
  * 
- * @description 
- * 
- * Controls the outline behavior.
+ * @description Controls the outline behavior.
  * 
  * @signature `@outline DEPTH TAG`
  * 
  * Controls the outline's depth and type.
  * 
- * @param {Number} [DEPTH=1] The number of headers below and including h2. For example,
- * `2` will include `h2` and `h3` elements.
+ * @param {Number} [DEPTH=1] The number of headers below and including h2. For
+ * example, `2` will include `h2` and `h3` elements.
  * 
  * @param {String} [TAG="ul"] Make the list an ordered list. 
  * 
  * @body
  * 
  */
 exports.outline = {
-		add: function (line, curData, scope, docMap) {
-			var m = line.match(/@outline\s+(\d+)(?:\s+(ol|ul))?/);
-			if(m) {
-				if(!this.outline) {
-					this.outline = {};
-				}
-				if(m[1]) {
-					this.outline.depth = +m[1];
-				}
-				if(m[2]) {
-					this.outline.tag = m[2];
-				}
+	add: function (line, curData, scope, docMap) {
+		var m = line.match(/@outline\s+(\d+)(?:\s+(ol|ul))?/);
+		if(m) {
+			if(!this.outline) {
+				this.outline = {};
+			}
+			if(m[1]) {
+				this.outline.depth = +m[1];
+			}
+			if(m[2]) {
+				this.outline.tag = m[2];
 			}
 		}
-	};
+	}
+};

toc.js

@@ -1,3 +1,21 @@
+/**
+ * @parent bit-docs-html-toc/static
+ * @module {function} bit-docs-html-toc/toc.js
+ * 
+ * Main front end JavaScript file for static portion of this plugin.
+ * 
+ * @signature `TOCContainer(el)`
+ * 
+ * Hydrates the container element with class `on-this-page-container` with the
+ * headers from the page.
+ * 
+ * If `DEPTH` was specified to the [bit-docs-html-toc/tags/outline] tag, then
+ * only headers less than and including that depth will be hydrated.
+ * 
+ * @param {HTMLElement} el The HTML element to hydrate.
+ * 
+ * @body
+ */
 var TOCContainer =  require("./toc-container-control");
 
 var el = document.getElementsByClassName("on-this-page-container");