Document a bunch of tags

Author: leoj3n

tags/class.js

@@ -16,7 +16,8 @@ var getParent = require("bit-docs-process-tags/get-parent"),
 	module.exports = {
 		add: function(line, curData, scope, docMap){
 			console.warn("Using the @class directive.  It is deprecated!");
-			// it's possible this has already been matched as something else ... clear parent
+			// it's possible this has already been matched as something else
+			// ... clear parent
 
 			this.type = "constructor";
 			var data = tnd(line);

tags/codeend.js

@@ -1,14 +1,13 @@
 	/**
 	 * @hide
-	 * @constructor documentjs.tags.codeend @codeend
-	 * @tag documentation
-	 * @parent documentjs.tags
+	 * @parent bit-docs-js/tags
+	 * @module {bit-docs-js/tag} bit-docs-js/tags/codeend @codeend
 	 * 
 	 * @description 
 	 * 
 	 * Stops a code block.
 	 * 
-	 * ###Example:
+	 * ### Example:
 	 * 
 	 * @codestart
 	 *
@@ -65,4 +64,4 @@
 			return ["poppop", out];
 		},
 		keepStack: true
-	};
+	};

tags/codestart.js

@@ -1,7 +1,7 @@
 	/**
-	 * @constructor documentjs.tags.codestart @codestart
 	 * @hide
-	 * @parent documentjs.tags 
+	 * @parent bit-docs-js/tags
+	 * @module {bit-docs-js/tag} bit-docs-js/tags/codestart @codestart
 	 * 
 	 * Starts a code block.  
 	 * 
@@ -11,7 +11,7 @@
 	 *   
 	 * Must end with "@codeend".
 	 * 
-	 * ###Example:
+	 * ### Example:
 	 * 
 	 * @codestart
 	 *

tags/function.js

@@ -8,8 +8,8 @@ keyFunction = /(?:([\w\.\$]+)|(["'][^"']+["']))\s*[:=].*function\s?\(([^\)]*)/;
 namedFunction = /\s*function\s+([\w\.\$]+)\s*(~)?\(([^\)]*)/;
 
 /**
- * @module {Object} bit-docs-js/tags/function @function
  * @parent bit-docs-js/tags
+ * @module {bit-docs-js/tag} bit-docs-js/tags/function @function
  *
  * @description Specifies the comment block is for a function. Use 
  * [bit-docs-js/tags/param] to specify the parameters of a function.
@@ -180,4 +180,4 @@ module.exports = {
 			data.params = [];
 		}
 	}
-};
+};

tags/module.md

@@ -1,17 +1,56 @@
-@module {bit-docs-process-tags/tag} bit-docs-js/tags/module @module
 @parent bit-docs-js/tags
+@module {bit-docs-process-tags/tag} bit-docs-js/tags/module @module
 
 Declares the export value for a module.
 
 @signature `@module {TYPE} NAME [TITLE]`
 
-@codestart
+```js
 /**
- * @module {{}} lib/componentProps props
- * @option {String} name The name of the component.
- * @option {String} title The title of the component.
- *|
-@codeend
+ * @module {{}} lib/settings settings
+ * @option {String} environment Production, development, or staging.
+ * @option {Number} requestTimeout How long to wait between requests.
+ */
+export default {
+    environment: "production",
+    requestTimeout: 10000
+}
+```
+
+```js
+// resulting docObject
+{
+  "type": "module",
+  "description": "",
+  "title": "settings",
+  "types": [
+    {
+      "type": "Object",
+      "options": [
+        {
+          "name": "environment",
+          "description": "Production, development, or staging.",
+          "types": [
+            {
+              "type": "String"
+            }
+          ]
+        },
+        {
+          "name": "requestTimeout",
+          "description": "How long to wait between requests.\n",
+          "types": [
+            {
+              "type": "Number"
+            }
+          ]
+        }
+      ]
+    }
+  ],
+  "name": "lib/settings"
+}
+```
 
 @param {bit-docs-type-annotate/typeExpression} [TYPE] A
 [bit-docs-type-annotate/typeExpression type expression]. This is typically an
@@ -30,7 +69,7 @@ exports you might use as one of the following:
 
 #### A single function export
 
-```
+```js
 /**
  * @module {function} multi/util/add
  * @parent multi/modules
@@ -50,7 +89,7 @@ module.exports = function(first, second) {
 
 #### Multiple export values
 
-```
+```js
 /**
  * @module {Module} multi/util/date-helpers
  * @parent multi/modules
@@ -73,7 +112,7 @@ exports.yesterday = function() { ... };
 
 #### A single constructor function export
 
-```
+```js
 /**
  * @module {function(new:multi/lib/graph)} multi/lib/graph
  * @parent multi/modules

tags/option.js

@@ -53,9 +53,8 @@ var setOptionData = function (option, data) {
 };
 
 /**
- * @module {bit-docs-process-tags/tag} bit-docs-js/tags/option @option
- * @tag documentation
  * @parent bit-docs-js/tags
+ * @module {bit-docs-process-tags/tag} bit-docs-js/tags/option @option
  *
  * Describes a property of the object, or an argument of the function, that was
  * specified in an [bit-docs-js/tags/param] tag.
@@ -73,10 +72,9 @@ var setOptionData = function (option, data) {
  *  * @param {function(Orders.List)} [success(orders)] Callback function.
  *  * @option orders A list of [Orders] that match `params`.
  *  *|
- * find: function( params, success ) {
+ * find: function( params, success ) { ... }
  * @codeend
  *
- *
  * @param {bit-docs/typeExpression} [TYPE] A [bit-docs/typeExpression type expression]. Examples:
  *
  * `{String}` - type is a `String`.
@@ -95,13 +93,11 @@ var setOptionData = function (option, data) {
  *  *|
  * @codeend
  * 
- * 
  * @param {bit-docs/nameExpression} NAME A [bit-docs/nameExpression name expression]. Examples:
  *
  * `age` - age is item.
  * `[age]` - age is item, age is optional.
  * `[age=0]` - age defaults to 0.
- *
  * 
  * @param {Markdown} [DESCRIPTION] Markdown content that continues for multiple lines.
  */

tags/param.js

@@ -34,8 +34,8 @@ var addParam = function (param, params) {
 };
 
 /**
- * @module {Object} bit-docs-js/tags/param @param
  * @parent bit-docs-js/tags
+ * @module {Object} bit-docs-js/tags/param @param
  *
  * Specifies parameter information for [bit-docs-js/tags/function] or
  * [bit-docs-js/tags/signature].
@@ -125,8 +125,8 @@ module.exports = {
 			}
 		}
 
-		// if we have a signiture, add this param to the last
-		// signiture
+		// if we have a signature, add this param to the last
+		// signature
 		if (this.signatures) {
 			this.signatures[this.signatures.length - 1].params.push(param);
 		} else {
@@ -171,4 +171,4 @@ module.exports = {
 
 		delete this._curParam;
 	}
-};
+};

tags/property.js

@@ -3,8 +3,8 @@ var getParent = require("bit-docs-process-tags/get-parent"),
 	updateNameWithScope = require("../lib/updateNameAndParentWithScope");
 
 /**
- * @module {bit-docs-process-tags/tag} bit-docs-js/tags/property @property
  * @parent bit-docs-js/tags
+ * @module {bit-docs-process-tags/tag} bit-docs-js/tags/property @property
  *
  * Documents a property of a parent object.
  *

tags/prototype.js

@@ -2,8 +2,8 @@ var getParent = require("bit-docs-process-tags/get-parent"),
 	tnd = require("bit-docs-type-annotate").typeNameDescription;
 
 /**
- * @module {bit-docs-process-tags/tag} bit-docs-js/tags/prototype @prototype
  * @parent bit-docs-js/tags
+ * @module {bit-docs-process-tags/tag} bit-docs-js/tags/prototype @prototype
  *
  * Declares that [bit-docs-js/tags/property] and [bit-docs-js/tags/function]
  * tags belong to the preceeding [bit-docs-js/tags/function]'s prototype

tags/return.js

@@ -11,30 +11,30 @@ var addReturnToTypes = function(tagData, returns){
 	}
 };
 
-	/**
-	 * @constructor documentjs.tags.return @return
-	 * @parent documentjs.tags
-	 *
-	 * Describes a function's return value.
-	 *
-	 * @signature `@return {TYPE} DESCRIPTION`
-	 *
-	 * @codestart javascript
-	 * /**
-	 *  * Capitalizes a string
-	 *  * @@param {String} s the string to be lowercased.
-	 *  * @@return {String} a string with the first character capitalized,
-	 *  * and everything else lowercased
-	 *  *|
-	 * capitalize: function( s ) { ... }
-	 * @codeend
-	 *
-	 * @param {documentjs.typeExpression} [TYPE] The type of
-	 * return value.
-	 *
-	 * @param {String} [DESCRIPTION] The description of the
-	 * return value.
-	 */
+/**
+ * @parent bit-docs-js/tags
+ * @module {bit-docs-js/tag} bit-docs-js/tags/return @return
+ *
+ * Describes a function's return value.
+ *
+ * @signature `@return {TYPE} DESCRIPTION`
+ *
+ * @codestart javascript
+ * /**
+ *  * Capitalizes a string
+ *  * @@param {String} s the string to be lowercased.
+ *  * @@return {String} a string with the first character capitalized,
+ *  * and everything else lowercased
+ *  *|
+ * capitalize: function( s ) { ... }
+ * @codeend
+ *
+ * @param {documentjs.typeExpression} [TYPE] The type of
+ * return value.
+ *
+ * @param {String} [DESCRIPTION] The description of the
+ * return value.
+ */
 module.exports = {
 	add: function( line, tagData ) {