@param module

Specifies parameter information for bit-docs-js/tags/function or @signature.

@param {TYPE} NAME [DESCRIPTION] 

/**
 * Finds an order by id.
 * @param {String} [id=0] Order identification number.
 * @param {function(Order)} [success(order)] Callback function.
 */
findById: function( id, success ) {

Parameters

  1. TYPE {TYPE-EXPRESSION}:

    A type expression.

    Use @option to describe a function's arguments, or an object's properties.

  2. NAME {NAME-EXPRESSION}:

    A name expression.

  3. DESCRIPTION {Markdown}:

    Markdown content that continues for multiple lines.

A "parameter" is a method definition variable, like a in function(a).

Use @param within a bit-docs-js/tags/function comment block, or after an @signature tag.

Use within a comment block

If the comment block precedes a function declaration, like:

/**
 * Finds an order by id.
 * @param {String} [id=0] Order identification number.
 * @param {function(Order)} [success(order)] Filter order search by this.
 */
findById: function( id, success ) {

Then bit-docs will automatically set the type to function for the DocObject representing that comment, and create params with names only (in this case id and success, and no description).

The comment's @params tags should use the same names as the function. Any param that specifies a name that isn't present is added at the end of the arguments.

Use after @signature

Use @param to specify the parameter variables of a signature.

/**
 * Finds an order by id.
 *
 * @signature `Order.findById(id=0,[success])`
 *
 * @param {String} [id=0] Order identification number.
 * @param {function(Order)} [success(order)] Callback function.
 */
findById: function( id, success ) {

When a @signature is used, any params automatically created from code are overwritten.