vanilla ckeditor-3.6.6.1

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

diff --git a/_source/core/eventInfo.js b/_source/core/eventInfo.js
index 7f534d7..7e39cf4 100644 (file)
--- a/_source/core/eventInfo.js
+++ b/_source/core/eventInfo.js
@@ -1,5 +1,5 @@
 /*\r
-Copyright (c) 2003-2009, CKSource - Frederico Knabben. All rights reserved.\r
+Copyright (c) 2003-2013, CKSource - Frederico Knabben. All rights reserved.\r
 For licensing, see LICENSE.html or http://ckeditor.com/license\r
 */\r
 \r
@@ -10,11 +10,11 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
  */\r
 \r
 /**\r
- * This class is not really part of the API. It just illustrates the features\r
- * of the event object passed to event listeners by a {@link CKEDITOR.event}\r
- * based object.\r
+ * (Virtual Class) Do not call this constructor. This class is not really part\r
+ * of the API.\r
+ * @class Virtual class that illustrates the features of the event object to be\r
+ * passed to event listeners by a {@link CKEDITOR.event} based object.\r
  * @name CKEDITOR.eventInfo\r
- * @constructor\r
  * @example\r
  * // Do not do this.\r
  * var myEvent = new CKEDITOR.eventInfo();  // Error: CKEDITOR.eventInfo is undefined\r
@@ -118,3 +118,15 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
  *     });\r
  * alert( someObject.fire( 'someEvent' ) );  // "true"\r
  */\r
+\r
+/**\r
+ * Removes the current listener.\r
+ * @name CKEDITOR.eventInfo.prototype.removeListener\r
+ * @function\r
+ * @example\r
+ * someObject.on( 'someEvent', function( event )\r
+ *     {\r
+ *         <b>event.removeListener()</b>;\r
+ *                     // Now this function won't be called again by 'someEvent'\r
+ *     });\r
+ */\r