Browse Source

Changed DOMEmiterMixin docs after EmiterMixin refactoring.

Oskar Wrobel 9 years ago
parent
commit
c75e81e114
1 changed files with 11 additions and 6 deletions
  1. 11 6
      packages/ckeditor5-ui/src/domemittermixin.js

+ 11 - 6
packages/ckeditor5-ui/src/domemittermixin.js

@@ -47,10 +47,12 @@ extend( ProxyEmitter.prototype, EmitterMixin, {
 	 *
 	 * @param {String} event The name of the event.
 	 * @param {Function} callback The function to be called on event.
-	 * @param {Object} [ctx] The object that represents `this` in the callback. Defaults to the object firing the
+	 * @param {Object} [options={}] Additional options.
+	 * @param {utils.PriorityString|Number} [options.priority='normal'] The priority of this event callback. The higher
+	 * the priority value the sooner the callback will be fired. Events having the same priority are called in the
+	 * order they were added.
+	 * @param {Object} [options.ctx] The object that represents `this` in the callback. Defaults to the object firing the
 	 * event.
-	 * @param {Number} [priority=10] The priority of this callback in relation to other callbacks to that same event.
-	 * Lower values are called first.
 	 *
 	 * @method ui.ProxyEmitter#on
 	 */
@@ -167,9 +169,12 @@ const DOMEmitterMixin = extend( {}, EmitterMixin, {
 	 * @param {utils.Emitter|Node} emitter The object that fires the event.
 	 * @param {String} event The name of the event.
 	 * @param {Function} callback The function to be called on event.
-	 * @param {Object} [ctx] The object that represents `this` in the callback. Defaults to `emitter`.
-	 * @param {Number} [priority=10] The priority of this callback in relation to other callbacks to that same event.
-	 * Lower values are called first.
+	 * @param {Object} [options={}] Additional options.
+	 * @param {utils.PriorityString|Number} [options.priority='normal'] The priority of this event callback. The higher
+	 * the priority value the sooner the callback will be fired. Events having the same priority are called in the
+	 * order they were added.
+	 * @param {Object} [options.ctx] The object that represents `this` in the callback. Defaults to the object firing the
+	 * event.
 	 *
 	 * @method ui.DOMEmitterMixin#listenTo
 	 */