ソースを参照

Reverted incorrect changes and added additional improvements.

Piotrek Koszuliński 7 年 前
コミット
1efdb4e076

+ 1 - 1
packages/ckeditor5-utils/src/ckeditorerror.js

@@ -53,7 +53,7 @@ export default class CKEditorError extends Error {
 		/**
 		 * The additional error data passed to the constructor. Undefined if none was passed.
 		 *
-		 * @member {Object | undefined}
+		 * @member {Object|undefined}
 		 */
 		this.data = data;
 	}

+ 1 - 1
packages/ckeditor5-utils/src/dom/createelement.js

@@ -20,7 +20,7 @@ import { isString } from 'lodash-es';
  *
  * @param {Document} doc Document used to create element.
  * @param {String} name Name of the element.
- * @param {Object|null} [attributes] Object keys will become attributes keys and object values will became attributes values.
+ * @param {Object} [attributes] Object keys will become attributes keys and object values will became attributes values.
  * @param {Node|String|Array.<Node|String>} [children] Child or array of children. Strings will be automatically turned
  * into Text nodes.
  * @returns {Element} Created element.

+ 1 - 1
packages/ckeditor5-utils/src/dom/getpositionedancestor.js

@@ -12,7 +12,7 @@ import global from './global';
 /**
  * For a given element, returns the nearest ancestor element which CSS position is not "static".
  *
- * @param {HTMLElement} [element] Native DOM element to be checked.
+ * @param {HTMLElement} element The native DOM element to be checked.
  * @returns {HTMLElement|null}
  */
 export default function getPositionedAncestor( element ) {

+ 1 - 1
packages/ckeditor5-utils/src/keyboard.js

@@ -43,7 +43,7 @@ export const keyCodes = generateKnownKeyCodes();
  *
  * Note: Key names are matched with {@link module:utils/keyboard~keyCodes} in a case-insensitive way.
  *
- * @param {String|module:utils/keyboard~KeystrokeInfo} key name (see {@link module:utils/keyboard~keyCodes})
+ * @param {String|module:utils/keyboard~KeystrokeInfo} Key name (see {@link module:utils/keyboard~keyCodes})
  * or a keystroke data object.
  * @returns {Number} Key or keystroke code.
  */

+ 3 - 3
packages/ckeditor5-utils/src/keystrokehandler.js

@@ -81,8 +81,8 @@ export default class KeystrokeHandler {
 	 * @param {String|Array.<String|Number>} keystroke Keystroke defined in a format accepted by
 	 * the {@link module:utils/keyboard~parseKeystroke} function.
 	 * @param {Function} callback A function called with the
-	 * {@link module:utils/keyboard~KeystrokeInfo keystroke info} object and
-	 * a helper to both `preventDefault` and `stopPropagation` of the event.
+	 * {@link module:engine/view/observer/keyobserver~KeyEventData key event data} object and
+	 * a helper funcion to call both `preventDefault()` and `stopPropagation()` on the underlying event.
 	 * @param {Object} [options={}] Additional options.
 	 * @param {module:utils/priorities~PriorityString|Number} [options.priority='normal'] The priority of the keystroke
 	 * callback. The higher the priority value the sooner the callback will be executed. Keystrokes having the same priority
@@ -114,7 +114,7 @@ export default class KeystrokeHandler {
 	/**
 	 * Triggers a keystroke handler for a specified key combination, if such a keystroke was {@link #set defined}.
 	 *
-	 * @param {module:utils/keyboard~KeystrokeInfo} keyEvtData Key event data.
+	 * @param {module:engine/view/observer/keyobserver~KeyEventData} keyEvtData Key event data.
 	 * @returns {Boolean} Whether the keystroke was handled.
 	 */
 	press( keyEvtData ) {