Consolidate types into /types

Author: leoj3n

build/builder.md

@@ -8,28 +8,27 @@ var buildHash = require("./build_hash");
 
 /**
  * @parent bit-docs-generate-html/modules
- * @module {function} bit-docs-generate-html/build/renderer renderer
+ * @module {function} bit-docs-generate-html/build/renderer
  *
- * Creates a renderer function used to generate
- * the documentation.
+ * Creates a renderer function used to generate the documentation.
  *
- * @signature `.build.renderer(buildTemplatesPromise, options)`
+ * @signature `build.renderer(buildTemplatesPromise, options)`
  *
- * Registers all `.mustache` files in the _documentjs/site/templates_ folder as
- * partials and creates a [documentjs.generators.html.types.renderer renderer] function that
- * renders the `content.mustache` template within the `layout.mustache` template.
+ * Registers all `.mustache` files in the
+ * [bit-docs-generate-html/site/templates/buildHash] folder as partials and
+ * creates a [bit-docs-generate-html/types/renderer] function that renders the
+ * `content.mustache` template within the `layout.mustache` template.
  *
  * @param {Promise<Handlebars>} buildTemplatesPromise The result of calling
- * [documentjs.generators.html.build.templates]. Building the renderer
- * must happen after the templates have been copied over. Passing this
- * argument enforces that.
+ * [bit-docs-generate-html/build/templates]. Building the renderer must happen
+ * after the templates have been copied over. Passing this argument enforces
+ * that.
  *
  * @param {{}} options
  *
  * Options used to configure the behavior of the renderer.
  *
- *
- * @return {Promise<documentjs.generators.html.types.renderer>} A promise that
+ * @return {Promise<bit-docs-generate-html/types/renderer>} A promise that
  * resolves with the renderer function.
  */
 module.exports = function(buildTemplatesPromise, options){

build/make_helpers.md

@@ -0,0 +1,32 @@
+@parent bit-docs-generate-html/types
+@typedef {function(Object,{})} bit-docs-generate-html/types/builder(options,folders) Builder
+
+A function that builds the static resources and copies the ones needed for
+the html site to a distributable location.
+
+@param {Object} options The options passed to [bit-docs/lib/generate/generate]. 
+
+@param {{dist: String, build: String}} folders Paths to where the build
+should take place and the final static content should be copied to.
+
+  @option {String} build The path where the default static and
+  `options.static` content have been copied.
+  
+  @option {String} dist The path where the final static content should be
+  copied after it has been minified and prepared.
+
+@return {Promise} A promise that resolves when the build and copying have
+been successful.
+
+@body
+
+## Use
+
+A builder that simply copies all static content over:
+
+    var Q = require('q'),
+        fs = require('fs-extra'),
+        copy = Q.denodify(fs.copy);
+    module.exports = function(options, folders){
+      return copy(folders.build, folders.dist);
+    };

build/renderer.js

@@ -0,0 +1,36 @@
+@parent bit-docs-generate-html/types
+@typedef {function(bit-docs/types/docMap,Object,function)} bit-docs-generate-html/types/makeHelpers(docMap,options,getCurrent) MakeHelpers
+
+@param {bit-docs/types/docMap} docMap Contains every
+[bit-docs/types/docObject] keyed by its name.
+
+@param {Object} options The options passed to [bit-docs/lib/generate/generate]. 
+
+@param {function():bit-docs/types/docObject} getCurrent Returns the current
+[bit-docs/types/docObject] being rendered.
+
+@param {bit-docs-generate-html} helpers The default helpers object that the
+return value will be added to.
+
+@return {Object<String,function>} A map of Handlebars function helpers that
+will be registered.
+
+@body
+
+## Use
+
+To create a helper that loops through every function's name excluding the
+current page's name:
+
+    module.exports = function(docMap,options,getCurrent, defaultHelpers, Handlebars){
+      return {
+        eachFunction: function(options){
+          for(var name in docMap) {
+            var docObject = docMap[name];
+            if(docObject.type === "function" && name !== getCurrent().name) {
+              return options.fn(name);
+            }
+          }
+        }
+      };
+    };

types/builder.md

@@ -1,5 +1,5 @@
 @parent bit-docs-generate-html/types
-@typedef {function(bit-docs/types/docObject)} bit-docs-generate-html/types/renderer(docObject) renderer
+@typedef {function(bit-docs/types/docObject)} bit-docs-generate-html/types/renderer(docObject) Renderer
 
 A renderer built by [bit-docs-generate-html/build/renderer] that is used to
 render each [bit-docs/types/docObject].