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

Processes @tags

/**
 * @parent bit-docs-process-tags/tags
 * @module {bit-docs-process-tags/types/tag} bit-docs-process-tags/tags/add @add
 * 
 * @description 
 * 
 * Sets a [bit-docs/types/docObject] as the current scope.
 * 
 * @signature `@add NAME`
 * 
 * @param {STRING} NAME The name of [bit-docs/types/docObject] to set as the
 * scope.
 * 
 * @body
 * 
 * ## Use
 * 
 * [bit-docs-js/tags/function] or [bit-docs-js/tags/property] tags created
 * without a name, or with a "short name" will use the current scope to guess
 * their full name and parent. `@add` can set the scope, allowing comments to
 * not have to write out a full name and [bit-docs-process-tags/tags/parent]
 * tag.
 * 
 * In the following example, a [bit-docs/types/docObject] named
 * `lib.Component.prototype.plugin` and `lib.Component.prototype.draw` will be
 * created, each with `lib.Component.prototype` as their parent.
 * 
 * @codestart javascript
 * /** @@add lib.Component.prototype *|
 * lib.extend(lib.Component.prototype,{
 *   /**
 *    * A plugin method on [lib.Component]
 *    *|
 *   plugin: function(){},
 *   /**
 *    * @property draw
 *    * A plugin method on [lib.Component]
 *    *|
 *   draw: {}
 * })
 * @codeend
 */
module.exports = {
	add: function(line, curData, scope, docMap){
		
		var name = line.match(/\s*@add\s*([^\s]+)/)[1]
		if(name){
			var docObject = docMap[name] ?
				docMap[name] :
				// add type so it can be hit by prototype and such
				docMap[name] = {name: name, type: "add"};
			
			return ["scope",docObject, docObject];
		}
	}
};