markdox/lib/formatter.js

Markdox is a documentation generator based on Dox and Markdown with support for JavaScript, CoffeeScript and IcedCoffeeScript.

var formatter = {};

formatter.format = function (docfile) {
  var result = [];

  docfile.javadoc.forEach(function(javadoc, index){

    var type = (javadoc.ctx && javadoc.ctx.type);
    var name = (javadoc.ctx && typeof javadoc.ctx.name === 'string') ? javadoc.ctx.name : '';

    var description = '';
    var paramStr = [];
    var propertyTags = [];
    var paramTags = [];
    var returnTags = [];
    var throwsTags = [];
    var tagDeprecated = false;
    var tagName = '';
    var tagClass = '';
    var tagFunction = '';
    var tagMethod = '';
    var tagNamespace = '';
    var tagSee = '';
    var tagVersion = '';
    var tagAuthor = '';

    javadoc.tags.forEach(function(tag){

      if (tag.type == 'param') {
        tag.joinedTypes = tag.types.join('|').replace('<', '\\<');
        paramTags.push(tag);
        paramStr.push(tag.name);
      } else if (tag.type == 'property') {
        tag.joinedTypes = tag.types.join('|').replace('<', '\\<');
        propertyTags.push(tag);
      } else if (tag.type == 'return' || tag.type == 'returns') {
        tag.joinedTypes = tag.types.join('|').replace('<', '\\<');
        returnTags.push(tag);
      } else if (tag.type == 'throws') {
        tag.joinedTypes = tag.types.join('|').replace('<', '\\<');
        throwsTags.push(tag);
      } else if (tag.type == 'namespace') {
        type = 'namespace';
        tagNamespace = tag.string;
      } else if (tag.type == 'method') {
        type = 'method';
        tagMethod = tag.string;
      } else if (tag.type == 'class') {
        type = 'class';
        tagClass = tag.string;
      } else if (tag.type == 'function') {
        type = 'function';
        tagFunction = tag.string;
      } else if (tag.type == 'name') {
        tagName = tag.string;
      } else if (tag.type == 'see') {
        tagSee = tag.url ? tag.url : tag.local;
      } else if (tag.type == 'version') {
        tagVersion = tag.string;
      } else if (tag.type == 'deprecated') {
        tagDeprecated = true;
      } else if (tag.type == 'author') {
        tagAuthor = tag.string;
      }
    });

    name = tagName !== '' ? tagName
         : tagMethod !== '' ? tagMethod
         : tagClass !== '' ? tagClass
         : tagFunction !== '' ? tagFunction
         : tagNamespace !== '' ? tagNamespace
         : name;

    description = javadoc.description.full
                      .replace(/\nh1/, '#')
                      .replace(/\nh2/, '##')
                      .replace(/\nh3/, '###')
                      .replace(/\nh4/, '####')
                      .replace(/\nh5/, '#####')
                      .replace(/\nh6/, '######')
                      .replace(/^h1/, '#')
                      .replace(/^h2/, '##')
                      .replace(/^h3/, '###')
                      .replace(/^h4/, '####')
                      .replace(/^h5/, '#####')
                      .replace(/^h6/, '######');


    docfile.javadoc[index] = {
      name: name
      , paramStr: paramStr.join(', ')
      , paramTags: paramTags
      , propertyTags: propertyTags
      , returnTags: returnTags
      , throwsTags: throwsTags
      , author: tagAuthor
      , version: tagVersion
      , see: tagSee
      , deprecated: tagDeprecated

      , type: type
      , isMethod: type === 'method'
      , isFunction: type === 'function'
      , isClass: type === 'class'
      , isNamespace: type === 'namespace'
      , description: description
      , ignore: javadoc.ignore
      , raw: javadoc
    };
  });

  return docfile;
};

module.exports = formatter;