bit-docs-process-tags/tags/description.js

Processes @tags

/**
 * @parent bit-docs-process-tags/tags
 * @module {bit-docs-process-tags/types/tag} bit-docs-process-tags/tags/description @description
 * 
 * @description 
 * 
 * Markdown content placed before all signature and API content.
 * 
 * @signature `@description`
 * 
 * Content after the `@description` tag appears after the title, but before
 * signature and API content.
 * 
 * `@description` tag content is treated as markdown and set as the
 * [bit-docs/types/docObject]'s `description` property.
 * 
 * @body
 * 
 * ## Use
 * 
 * The description of a [bit-docs/types/docObject] is displayed at the top of
 * an html page generated with the
 * [bit-docs-generate-html default html generator]. It also appears in the
 * `title` attribute of links.
 * 
 * In the following example, `@description` stops content from being added to
 * [bit-docs-js/tags/param], and instead makes content be added to the
 * description property.
 * 
 * @codestart javascript
 * /**
 *  * @param {String} name The name of the
 *  * component.
 *  * 
 *  * @description
 *  * A component for lib.
 *  *|
 * lib.Component = function(name){}
 * @codeend
 * 
 * By default the first paragraph of content that is not after a multi-line tag
 * like [bit-docs-js/tags/signature], [bit-docs-js/tags/param], etc, is set as
 * the [bit-docs-process-tags/tags/description]. All content after the first
 * paragraph is set as the body content.
 * 
 * You can see what is treated as description and body by default in the
 * following example:
 * 
 * @codestart javascript
 * /**
 *  * @function 
 *  * 
 *  * DESCRIPTION DESCRIPTION
 *  * DESCRIPTION DESCRIPTION
 *  * 
 *  * BODY BODY
 *  * BODY BODY
 *  * 
 *  * BODY BODY
 *  * 
 *  * @signature `.cols(cols)` SIGNATURE_DESCRIPTION
 *  * SIGNATURE_DESCRIPTION SIGNATURE_DESCRIPTION
 *  *
 *  * @body
 *  * BODY BODY
 *  *|
 * Graph.prototype.cols = function(cols){ ... }
 * @codeend
 */
module.exports = {
	add: function( line ) {
		var m = line.match(/^\s*@description\s*(.*)/)
		if ( m ) {
			this.description = m[1]+" ";
			return ["default","description"]
		}
	}
};