@jjavery/dmd-jjavery/src/helper/bb-link.js

Plugin for jsdoc2md to produce markdown suitable for API documentation

'use strict';

var BBLINK_PREFIX = '#markdown-header-',
  links = {};
function getLink(parent, name, link) {
  if (parent === 'event') return name.toLowerCase();
  var sig = parent + '#' + name,
    out = links[sig];
  if (link) {
    links[sig] = link;
    out = link;
  } else if (!out) {
    sig = 'null#' + name;
    out = links[sig];
  }

  return out;
}

exports.bbLink = function (
  parent,
  prefix,
  accessSymbol,
  name,
  methodSign,
  returnTypes
) {
  var link = [
    parent,
    prefix ? prefix + ' ' : '',
    accessSymbol,
    name,
    methodSign,
    returnTypes ? ' ' + returnTypes : ''
  ]
    .join('')
    .replace(/[^ \w]+/g, '')
    .replace(/ +/g, '-')
    .toLowerCase();
  return getLink(parent, name, link);
};

exports.bbGuessLink = function (
  parent,
  prefix,
  accessSymbol,
  name,
  methodSign,
  returnTypes
) {
  var link = getLink(parent, name);
  if (link) {
    return '[' + name + '](' + BBLINK_PREFIX + link + ')';
  }
  return name;
};

exports.bbParseLink = function (roughName) {
  if (!roughName) return;
  if (roughName.indexOf('http') >= 0) {
    return '[' + roughName + '](' + roughName + ')';
  }
  var parts = roughName.split(/[#\.:]/),
    link = getLink(parts[0], parts[1]);
  if (link) {
    return '[' + roughName + '](' + BBLINK_PREFIX + link + ')';
  }
  return roughName;
};