puppy-api-docs/lib/docUtils.js

Genernate material api docs from your comments.

const DocGroup = require('../models/docGroup');

const docUtils = {};

/**
 * 
 * @param {[Doc]} docs Array of parsed documents from all the .js files.
 * @returns {[DocGroup]} Return array of docs grouped together in DocGroup.
 */
docUtils.groupDocs = (docs) => {
    const groups = {};

    docs.forEach((doc) => {
        if (!doc.group) {
            doc.group = "API\'s";
        }

        if (groups[doc.group] === undefined) {
            groups[doc.group] = [];
        }

        groups[[doc.group]].push(doc);
    });

    const docGroups = [];

    for (let key in groups) {
        docGroups.push(new DocGroup({
            group: key,
            docs: groups[key]
        }));
    }

    return docGroups;
}

module.exports = docUtils;