@signature module

Specifies a signature for a @function but can work with any other tag.

@signature `SIGNATURE` DESCRIPTION 

/**
 * Capitalizes a string.
 * @signature `can.capitalize(s)` Example:
 *
 *     can.capitalize("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}:

    Describes the behavior of the signature.