X-Git-Url: https://jasonwoof.com/gitweb/?a=blobdiff_plain;f=_source%2Fcore%2Fevent.js;h=8c1fe96a741e657471b5e04c3a833e518b45f288;hb=3fe9cac293e090ea459a3ee10d78cbe9e1dd0e03;hp=306e8fc2e95b26cb2d948e199389b5f86a227891;hpb=941b0a9ba4e673e292510d80a5a86806994b8ea6;p=ckeditor.git diff --git a/_source/core/event.js b/_source/core/event.js index 306e8fc..8c1fe96 100644 --- a/_source/core/event.js +++ b/_source/core/event.js @@ -1,5 +1,5 @@ /* -Copyright (c) 2003-2010, CKSource - Frederico Knabben. All rights reserved. +Copyright (c) 2003-2013, CKSource - Frederico Knabben. All rights reserved. For licensing, see LICENSE.html or http://ckeditor.com/license */ @@ -11,9 +11,15 @@ For licensing, see LICENSE.html or http://ckeditor.com/license if ( !CKEDITOR.event ) { /** - * This is a base class for classes and objects that require event handling - * features. - * @constructor + * Creates an event class instance. This constructor is rearely used, being + * the {@link #.implementOn} function used in class prototypes directly + * instead. + * @class This is a base class for classes and objects that require event + * handling features.
+ *
+ * Do not confuse this class with {@link CKEDITOR.dom.event} which is + * instead used for DOM events. The CKEDITOR.event class implements the + * internal event system used by the CKEditor to fire API related events. * @example */ CKEDITOR.event = function() @@ -21,7 +27,7 @@ if ( !CKEDITOR.event ) /** * Implements the {@link CKEDITOR.event} features in an object. - * @param {Object} targetObject The object in which implement the features. + * @param {Object} targetObject The object into which implement the features. * @example * var myObject = { message : 'Example' }; * CKEDITOR.event.implementOn( myObject }; @@ -31,7 +37,7 @@ if ( !CKEDITOR.event ) * }); * myObject.fire( 'testEvent' ); */ - CKEDITOR.event.implementOn = function( targetObject, isTargetPrototype ) + CKEDITOR.event.implementOn = function( targetObject ) { var eventProto = CKEDITOR.event.prototype; @@ -77,7 +83,8 @@ if ( !CKEDITOR.event ) * Registers a listener to a specific event in the current object. * @param {String} eventName The event name to which listen. * @param {Function} listenerFunction The function listening to the - * event. + * event. A single {@link CKEDITOR.eventInfo} object instanced + * is passed to this function containing all the event data. * @param {Object} [scopeObj] The object used to scope the listener * call (the this object. If omitted, the current object is used. * @param {Object} [listenerData] Data to be sent as the