vanilla ckeditor-3.4.2

[ckeditor.git] / _source / core / event.js

diff --git a/_source/core/event.js b/_source/core/event.js
index 306e8fc..114d22e 100644 (file)
--- a/_source/core/event.js
+++ b/_source/core/event.js
@@ -11,9 +11,15 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 if ( !CKEDITOR.event )\r
 {\r
        /**\r
-        * This is a base class for classes and objects that require event handling\r
-        * features.\r
-        * @constructor\r
+        * Creates an event class instance. This constructor is rearely used, being\r
+        * the {@link #.implementOn} function used in class prototypes directly\r
+        * instead.\r
+        * @class This is a base class for classes and objects that require event\r
+        * handling features.<br />\r
+        * <br />\r
+        * Do not confuse this class with {@link CKEDITOR.dom.event} which is\r
+        * instead used for DOM events. The CKEDITOR.event class implements the\r
+        * internal event system used by the CKEditor to fire API related events.\r
         * @example\r
         */\r
        CKEDITOR.event = function()\r
@@ -21,7 +27,7 @@ if ( !CKEDITOR.event )
 \r
        /**\r
         * Implements the {@link CKEDITOR.event} features in an object.\r
-        * @param {Object} targetObject The object in which implement the features.\r
+        * @param {Object} targetObject The object into which implement the features.\r
         * @example\r
         * var myObject = { message : 'Example' };\r
         * <b>CKEDITOR.event.implementOn( myObject }</b>;\r
@@ -31,7 +37,7 @@ if ( !CKEDITOR.event )
         *     });\r
         * myObject.fire( 'testEvent' );\r
         */\r
-       CKEDITOR.event.implementOn = function( targetObject, isTargetPrototype )\r
+       CKEDITOR.event.implementOn = function( targetObject )\r
        {\r
                var eventProto = CKEDITOR.event.prototype;\r
 \r
@@ -77,7 +83,8 @@ if ( !CKEDITOR.event )
                         * Registers a listener to a specific event in the current object.\r
                         * @param {String} eventName The event name to which listen.\r
                         * @param {Function} listenerFunction The function listening to the\r
-                        *              event.\r
+                        *              event. A single {@link CKEDITOR.eventInfo} object instanced\r
+                        *              is passed to this function containing all the event data.\r
                         * @param {Object} [scopeObj] The object used to scope the listener\r
                         *              call (the this object. If omitted, the current object is used.\r
                         * @param {Object} [listenerData] Data to be sent as the\r