@body

constructor

documentjs.tags.body

source

Markdown content placed after all signature and API content.

@body

Content after the @body tag appears after the title, description, signature and API content.

@body tag content is treated as markdown and set as the docObject's body property.

Use

The body of a docObject is displayed at the bottom of an html page generated with the default html generator.

In the following example, @body stops content from being added to @param, and instead makes content be added to the body property.

/**
 * A component for lib.
 * 
 * @param {String} name The name of the
 * component.
 * 
 * @body
 * 
 * ## Use
 * 
 * ```
 * new lib.Component("name")
 * ```
 */
lib.Component = function(name){}

By default the first paragraph of content that is not after a multi-line tag like @signature, @param, etc, is set as the @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:

/**
 * @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){ ... }