@signature

  • constructor
documentjs.tags.signature  

Specifies a signature for a [documentjs/tags/function @function] but can work with any other tag.

@signature `SIGNATURE` DESCRIPTION 

/**
 * Capitalizes a string.
 * @signature `CanCapitalize(s)` Example:
 *
 *     CanCapitalize("foo") //-> "Bar"
 * 
 * @param {String} s the string to be lowercased.
 * @return {String} a string with the first character capitalized, 
 * and everything else lowercased
 */
capitalize: function( s ) { ... }

Parameters

  1. SIGNATURE {String}

    Code that describes how a method should be called.

  2. DESCRIPTION {String}Optional

    Describes the behavior of the signature.