@property module

Documents a property of a parent object.

@property {TYPE} NAME [TITLE]

Documents a property named NAME of type {TYPE}.

/**
 * @property {Number} delay
 * Sets the delay in milliseconds between an ajax request is made and
 * the success and complete handlers are called.  This only sets
 * functional fixtures.  By default, the delay is 200ms.
 */
$.fixture.delay = 200

Parameters

  1. TYPE {TYPE-EXPRESSION}:

    An optional type like {Object}.

  2. NAME {NAME-EXPRESSION}:

    The name of the property. This maybe inferred from the code block immediately following the comment.

  3. TITLE {STRING}:

    The display title of the property.

["']?(\w+)["']?\s*[:=]\s*

If code matches the above regular expression and is not a function, it is automatically assumed to be a property.

Returns

{Tag}:

Object with functions that compose the @property tag.