Welcome GuestLogin

@event token

RSS
Modified on Thursday, 10 December 2009 12:26 by Administrator Categorized as Uncategorized
Documents an event that an object raises.

Example


/**
 * Provides support for working with drag events.
 * @event dragstart Fires right before the dragging operation starts.
 * @event dragstop Fires immediately after a dragging operation ends.
 * @event beforedragmove Fires continuously before a dragged element is moved .
 * @event dragmove Fires continuously after a dragged element is moved.
 */
Aeon.Utils.DragCoordinator = new function Aeon$DragCoordinator()
{
}

Description

Many JavaScript frameworks provide custom event firing mechanisms. This token enables documenting the events an object fires. How the event system is implemented is completely up to the framework implementing it.

This token consists of three parts:

@event name summary
description

  1. The name of the event. Required.
       (Alphanumeric characters only)
  2. The argument summary. Optional.
       (Any characters until the end of the line)
  3. The argument description. Optional.
       (Any characters from the start of the second line until the next token or until the end of the comment).

See also

All tokens
Events

ScrewTurn Wiki version 3.0.4.560. Some of the icons created by FamFamFam.