some prelim docs

Author: justinbmeyer

bit-docs.js

@@ -8,6 +8,18 @@ var mergeOnto = function(prop, dest, source){
     }
 };
 
+/**
+ * @module {function} bit-docs-generate-html
+ * @parent BitDocs
+ * @group bit-docs-generate-html/modules modules
+ *
+ * @description Generates HTML for a docMap.  Supports plugins.
+ *
+ * @body
+ *
+ * Blah blah
+ */
+
 module.exports = function(bitDocs){
     bitDocs.register("generator", generator);
 

build/renderer.js

@@ -9,28 +9,28 @@ var buildTemplates = require("./templates"),
 
 
 /**
- * @function documentjs.generators.html.build.renderer
- * @parent documentjs.generators.html.build.methods
- * 
+ * @module {function} bit-docs-generate-html/build/renderer
+ * @parent bit-docs-generate-html/modules
+ *
  * Creates a renderer function used to generate
  * the documentation.
- * 
+ *
  * @signature `.build.renderer(buildTemplatesPromise, options)`
- * 
- * Registers all `.mustache` files in the _documentjs/site/templates_ folder as 
+ *
+ * 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. 
- * 
- * @param {Promise<Handlebars>} buildTemplatesPromise The result of calling 
+ * 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 
+ * 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
  * resolves with the renderer function.
  */
@@ -49,4 +49,3 @@ module.exports = function(buildTemplatesPromise, options){
 		});
 	});
 };
-	

build/static_dist.js

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