dgeni-packages/jsdoc/services/transforms/extract-name.js

A collection of dgeni packages for generating documentation from source code

// Matches:
// name, [name], [name=default], name text, [name] text, [name=default] text, name - text, [name] - text or [name=default] - text
var NAME_AND_DESCRIPTION = /^\s*(\[([^\]=]+)(?:=([^\]]+))?\]|\S+)((?:[ \t]*-\s*|\s+)(\S[\s\S]*))?\s*$/;

/**
 * Extract the name information from a tag
 * @param  {Tag} tag The tag to process
 */
module.exports = function extractNameTransform() {
  return (doc, tag, value) => {

    tag.description = value.replace(NAME_AND_DESCRIPTION, (match, name, optionalName, defaultValue, description, dashDescription) => {
      tag.name = optionalName || name;

      if ( optionalName ) {
        tag.optional = true;
      }

      if ( defaultValue ) {
        tag.defaultValue = defaultValue;
      }

      const aliasParts = tag.name.split('|');
      tag.name = aliasParts[0];
      tag.alias = aliasParts[1];
      return dashDescription || description || '';
    });

    return tag.description;

  };
};