funcunit
Version:
<!-- @hide title
37 lines (32 loc) • 1.21 kB
JavaScript
var writeDocObject = require("./doc_object"),
Q = require("q");
/**
* @function documentjs.generators.html.write.docMap
* @parent documentjs.generators.html.write.methods
*
* Writes out every [documentjs.process.docObject docObject] within
* a [documentjs.process.docMap docMap].
*
* @signature `.write.docMap(docMap, renderer, options, setCurrentDocObjectForHelpers)`
*
* @param {documentjs.process.docMap} docMap
* @param {documentjs.generators.html.types.renderer} renderer
* @param {Object} options
* @param {function(documentjs.process.docObject)} setCurrentDocObjectForHelpers
* @return {Promise} Resolves when all docObjects have been written.
*/
module.exports = function(docMap, renderer, options, setCurrentDocObjectForHelpers){
var promises = [];
if(options.singlePage) {
var parent = docMap[options.parent];
parent.docMap = docMap;
return writeDocObject(parent, renderer, options, setCurrentDocObjectForHelpers);
} else {
// Go through each object and write it out.
for(var name in docMap){
var docObject = docMap[name];
promises.push(writeDocObject(docObject, renderer, options, setCurrentDocObjectForHelpers));
}
return Q.all(promises);
}
};