Update docs for /write

Author: leoj3n

write/doc_map.js

@@ -1,21 +1,23 @@
-var writeDocObject = require("./doc_object"),
-	Q = require("q");
+var writeDocObject = require("./doc_object");
+var Q = require("q");
+
 /**
- * @function documentjs.generators.html.write.docMap
- * @parent documentjs.generators.html.write.methods
+ * @parent bit-docs-generate-html/modules
+ * @module {function} bit-docs-generate-html/write/doc_map
  *
- * Writes out every [documentjs.process.docObject docObject] within
- * a [documentjs.process.docMap docMap].
+ * Writes out every [bit-docs/types/docObject] within a
+ * [bit-docs/types/docMap].
  *
- * @signature `.write.docMap(docMap, renderer, siteConfig, setCurrentDocObjectForHelpers)`
+ * @signature `docMap(docMap, renderer, siteConfig, setCurrentDocObjectForHelpers)`
  *
- * @param {documentjs.process.docMap} docMap
- * @param {documentjs.generators.html.types.renderer} renderer
+ * @param {bit-docs/types/docMap} docMap
+ * @param {bit-docs-generate-html/types/renderer} renderer
  * @param {Object} siteConfig
- * @param {function(documentjs.process.docObject)} setCurrentDocObjectForHelpers
- * @return {Promise} Resolves when all docObjects have been written.
+ * @param {function(bit-docs/types/docObject)} setCurrentDocObjectForHelpers
+ * 
+ * @return {Promise} Resolves when all [bit-docs/types/docObject]s have been
+ * written.
  */
-
 module.exports = function(docMap, renderer, siteConfig, setCurrentDocObjectForHelpers){
 
 	var promises = [];

write/doc_object.js

@@ -1,36 +1,38 @@
-var _ = require("lodash"),
-	filename = require("./filename"),
-	Q = require('q'),
-	fs = require("fs"),
-	writeFile = Q.denodeify(fs.writeFile),
-	path = require("path");
-	mkdirs = Q.denodeify(require("fs-extra").mkdirs);
+var _ = require("lodash");
+var filename = require("./filename");
+var Q = require('q');
+var fs = require("fs");
+var writeFile = Q.denodeify(fs.writeFile);
+var path = require("path");
+var mkdirs = Q.denodeify(require("fs-extra").mkdirs);
+
 /**
- * @function documentjs.generators.html.write.docObject
- * @parent documentjs.generators.html.write.methods
+ * @parent bit-docs-generate-html/modules
+ * @module {function} bit-docs-generate-html/write/doc_object
  *
- * Writes out a [documentjs.process.docObject docObject].
+ * Writes out a [bit-docs/types/docObject].
  *
- * @signature `.write.docObject(docObject, renderer, siteConfig, setCurrentDocObjectForHelpers)`
+ * @signature `docObject(docObject, renderer, siteConfig, setCurrentDocObjectForHelpers)`
  *
- * @param {documentjs.process.docObject} docObject The doc object to be written out.
+ * @param {bit-docs/types/docObject} docObject The [bit-docs/types/docObject]
+ * to be written out.
  *
- * @param {documentjs.generators.html.types.renderer} renderer A function that renders
- * the output.
+ * @param {bit-docs-generate-html/types/renderer} renderer A function that
+ * renders the output.
  *
  * @param {Object} siteConfig Configuration siteConfig.
  *
- * @option {String} dest The folder name this file will be written to. The
- * filename is determined from the docObject's name.
+ *   @option {String} dest The folder name this file will be written to. The
+ *   filename is determined from the [bit-docs/types/docObject]'s name.
  *
- * @param {function(documentjs.process.docObject)} setCurrentDocObjectForHelpers
+ * @param {function(bit-docs/types/docObject)} setCurrentDocObjectForHelpers
  *
  * @return {Promise} A promise that resolves when the file has been written out.
  */
 module.exports = function(docObject, renderer, siteConfig, setCurrentDocObjectForHelpers){
-
 	var out = path.join(siteConfig.dest, filename(docObject, siteConfig) );
 	var rendered;
+
 	if(siteConfig.debug) {
 		console.log('OUT: ' + path.relative(process.cwd(),out) );
 	}
@@ -43,10 +45,10 @@ module.exports = function(docObject, renderer, siteConfig, setCurrentDocObjectFo
 	} else {
 		rendered = renderer(docObject);
 	}
+	
 	return writeFile(out, rendered).catch(function(){
 		return mkdirs(path.dirname(out)).then(function(){
 			return writeFile(out, rendered);
 		});
 	});
-
 };

write/search_map.js

@@ -1,20 +1,22 @@
-var fs = require('fs'),
-	path = require('path'),
-	filename = require("./filename"),
-	Q = require('q'),
-	writeFile = Q.denodeify(fs.writeFile),
-	mkdirs = Q.denodeify(require("fs-extra").mkdirs);
+var fs = require('fs');
+var path = require('path');
+var filename = require("./filename");
+var Q = require('q');
+var writeFile = Q.denodeify(fs.writeFile);
+var mkdirs = Q.denodeify(require("fs-extra").mkdirs);
 
 /**
- * @function bitDocs.generators.html.write.searchMap
- * @parent bitDocs.generators.html.write.methods
+ * @parent bit-docs-generate-html/modules
+ * @module {function} bit-docs-generate-html/write/search_map
  *
- * Writes out a simplified [documentjs.process.docMap docMap] to be used for searching.
+ * Writes out a simplified [bit-docs/types/docMap] to be used for searching.
  *
- * @signature `.write.searchMap(docMap, siteConfig)`
+ * @signature `searchMap(docMap, siteConfig)`
  *
- * @param {documentjs.process.docMap} docMap
+ * @param {bit-docs/types/docMap} docMap
+ * 
  * @param {Object} siteConfig
+ * 
  * @return {Promise} Resolves when searchMap has been written.
  */
 module.exports = function(docMap, siteConfig) {

write/static_dist.js

@@ -1,29 +1,30 @@
-var fss = require('../fs_extras.js'),
-	Q = require('q'),
-	path = require("path"),
-	buildHash = require("../build/build_hash"),
-	fs = require('fs-extra'),
-	mkdirs = Q.denodeify(fs.mkdirs);
+var fss = require('../fs_extras.js');
+var Q = require('q');
+var path = require("path");
+var buildHash = require("../build/build_hash");
+var fs = require('fs-extra');
+var mkdirs = Q.denodeify(fs.mkdirs);
 
 /**
- * @function documentjs.generators.html.write.staticDist
- * @parent documentjs.generators.html.write.methods
+ * @parent bit-docs-generate-html/modules
+ * @module {function} bit-docs-generate-html/write/static_dist
  *
- * Copies the [documentjs.generators.html.build.staticDist built distributable]
+ * Copies the [bit-docs-generate-html/build/static_dist built distributable]
  * to a _static_ folder in `options.dest`.
  *
- * @signature `.write.staticDist(options)`
+ * @signature `staticDist(options)`
  *
  * @param {Object} options Configuration options.
  *
- * @option {String} dest The static distributable will be written to
- * `options.dest + "static"`.
+ *   @option {String} dest The static distributable will be written to
+ *   `{options.dest}/static`.
  *
  * @return {Promise} A promise that resolves when successfully copied over.
  */
 module.exports = function(options){
 	var dest = path.join(options.dest,"static");
 	var distFolder =  path.join('site','static','dist', buildHash(options));
+
 	return mkdirs(dest).then(function(){
 		if(options.debug) {
 			console.log("BUILD: Copying production files to "+path.relative(process.cwd(),dest));

write/write.js

@@ -1,16 +1,19 @@
 /**
- * @property {{}} documentjs.generators.html.write
- * @parent documentjs.generators.html.properties
+ * @parent bit-docs-generate-html/modules
+ * @module {{}} bit-docs-generate-html/write/write
  *
- * @group documentjs.generators.html.write.methods 0 methods
- *
- * A collection of helpers used to write out docObject and docMaps
- * using the structures produced by [documentjs.generators.html.build].
+ * A collection of helpers used to write out [bit-docs/types/docObject] and
+ * [bit-docs/types/docMap]s using the structures produced by
+ * [bit-docs-generate-html/build/build].
  *
  * @body
- *
+ * 
+ * Requires and exports these other modules:
+ * - [bit-docs-generate-html/write/doc_map] as `docMap`.
+ * - [bit-docs-generate-html/write/doc_object] as `docObject`.
+ * - [bit-docs-generate-html/write/static_dist] as `staticDist`.
+ * - [bit-docs-generate-html/write/search_map] as `searchMap`.
  */
-
 exports.docMap = require("./doc_map");
 exports.docObject = require("./doc_object");
 exports.staticDist = require("./static_dist");