Document stuff in /build

Author: leoj3n

build/helpers.js

@@ -1,19 +1,19 @@
-
-var getDefaultHelpers = require("./make_default_helpers"),
-	_ = require("lodash");
+var getDefaultHelpers = require("./make_default_helpers");
+var _ = require("lodash");
 var fsx = require('../fs_extras');
 var path = require('path');
 var md5 = require("md5");
-var Handlebars = require("handlebars"),
-	buildHash = require("./build_hash");
+var Handlebars = require("handlebars");
+var buildHash = require("./build_hash");
+
 /**
- * @function documentjs.generators.html.build.helpers
- * @parent documentjs.generators.html.build.methods
+ * @parent bit-docs-generate-html/modules
+ * @module {Promise} bit-docs-generate-html/build/helpers
  *
- * Gets the default helpers and helpers in the _documentjs/site/templates_ folder and
- * registers them with Handlebars.
- *
- * @signature `.build.helpers(buildTemplatesPromise, docMap, options, getCurrent)`
+ * Gets the default helpers, and helpers in the _{buildHash}/site/templates_
+ * folder, and registers them with Handlebars.
+ * 
+ * @signature `build.helpers(buildTemplatesPromise, docMap, options, getCurrent)`
  *
  * Registers helpers
  *
@@ -42,7 +42,7 @@ var Handlebars = require("handlebars"),
 module.exports = function(buildTemplatesPromise, docMap, options, getCurrent){
 
 	return buildTemplatesPromise.then(function(OtherHandlebars){
-		// get the default heleprs
+		// get the default helpers
 		var helpers = getDefaultHelpers(docMap,options,getCurrent, OtherHandlebars);
 
 		var templatesPath = path.join('site/templates', buildHash(options) );
@@ -73,8 +73,4 @@ module.exports = function(buildTemplatesPromise, docMap, options, getCurrent){
 
 	});
 
-
-
-
-
 };

build/make_default_helpers.js

@@ -386,11 +386,10 @@ module.exports = function(docMap, config, getCurrent, Handlebars){
 			}
 		},
 		/**
-		* @function documentjs.generators.html.defaultHelpers.makeParentTitle
-		*
-		* Returns the parent docObject's title.
-		*
-		*/
+		 * @function bit-docs-generate-html/theme/templates/helpers/getTitle
+		 *
+		 * Returns the parent docObject's title.
+		 */
 		getTitle: function(){
 			var root = docMap[config.parent];
 			return (root.title || root.name)+ " - "+(this.title || this.name);

build/renderer.js

@@ -9,8 +9,8 @@ var buildTemplates = require("./templates"),
 
 
 /**
- * @module {function} bit-docs-generate-html/build/renderer
  * @parent bit-docs-generate-html/modules
+ * @module {function} bit-docs-generate-html/build/renderer
  *
  * Creates a renderer function used to generate
  * the documentation.

build/static_dist.js

@@ -12,8 +12,8 @@ var queue = promiseLock(),
 	remove = Q.denodeify(fs.remove);
 
 /**
- * @module {function} bit-docs-generate-html/build/static_dist
  * @parent bit-docs-generate-html/modules
+ * @module {function} bit-docs-generate-html/build/static_dist
  *
  * Builds a static distributable which will eventually be copied
  * to the `static` folder of the generated output.