浏览代码

Docs: Started fixing

Maciek 9 年之前
父节点
当前提交
d2c9905c27
共有 35 个文件被更改,包括 174 次插入62 次删除
  1. 9 7
      packages/ckeditor5-utils/src/ckeditorerror.js
  2. 8 5
      packages/ckeditor5-utils/src/collection.js
  3. 4 0
      packages/ckeditor5-utils/src/comparearrays.js
  4. 4 2
      packages/ckeditor5-utils/src/config.js
  5. 4 0
      packages/ckeditor5-utils/src/count.js
  6. 4 1
      packages/ckeditor5-utils/src/diff.js
  7. 4 0
      packages/ckeditor5-utils/src/difftochanges.js
  8. 4 0
      packages/ckeditor5-utils/src/dom/createelement.js
  9. 4 0
      packages/ckeditor5-utils/src/dom/getancestors.js
  10. 4 0
      packages/ckeditor5-utils/src/dom/getcommonancestor.js
  11. 4 0
      packages/ckeditor5-utils/src/dom/getdatafromelement.js
  12. 4 0
      packages/ckeditor5-utils/src/dom/indexof.js
  13. 4 0
      packages/ckeditor5-utils/src/dom/insertat.js
  14. 4 0
      packages/ckeditor5-utils/src/dom/remove.js
  15. 4 0
      packages/ckeditor5-utils/src/dom/setdatainelement.js
  16. 4 0
      packages/ckeditor5-utils/src/dom/tounit.js
  17. 4 2
      packages/ckeditor5-utils/src/elementreplacer.js
  18. 4 0
      packages/ckeditor5-utils/src/emittermixin.js
  19. 6 4
      packages/ckeditor5-utils/src/env.js
  20. 9 7
      packages/ckeditor5-utils/src/eventinfo.js
  21. 4 1
      packages/ckeditor5-utils/src/focustracker.js
  22. 4 0
      packages/ckeditor5-utils/src/isiterable.js
  23. 20 20
      packages/ckeditor5-utils/src/keyboard.js
  24. 4 2
      packages/ckeditor5-utils/src/locale.js
  25. 4 0
      packages/ckeditor5-utils/src/log.js
  26. 4 0
      packages/ckeditor5-utils/src/mapsequal.js
  27. 4 0
      packages/ckeditor5-utils/src/mix.js
  28. 4 0
      packages/ckeditor5-utils/src/nth.js
  29. 4 0
      packages/ckeditor5-utils/src/objecttomap.js
  30. 9 5
      packages/ckeditor5-utils/src/observablemixin.js
  31. 4 2
      packages/ckeditor5-utils/src/priorities.js
  32. 4 1
      packages/ckeditor5-utils/src/spy.js
  33. 4 1
      packages/ckeditor5-utils/src/tomap.js
  34. 4 1
      packages/ckeditor5-utils/src/uid.js
  35. 1 1
      packages/ckeditor5-utils/src/unicode.js

+ 9 - 7
packages/ckeditor5-utils/src/ckeditorerror.js

@@ -3,22 +3,24 @@
  * For licensing, see LICENSE.md.
  * For licensing, see LICENSE.md.
  */
  */
 
 
+/**
+ * @module utils/ckeditorerror
+ */
+
 /**
 /**
  * The CKEditor error class.
  * The CKEditor error class.
  *
  *
  * All errors will be shortened during the minification process in order to reduce the code size.
  * All errors will be shortened during the minification process in order to reduce the code size.
- * Therefore, all error messages should be documented in the same way as those in {@link utils.log}.
- *
- * Read more in the {@link utils.log} module.
+ * Therefore, all error messages should be documented in the same way as those in {@link @module:utils/log}.
  *
  *
- * @memberOf utils
+ * Read more in the {@link module:utils/log} module.
  * @extends Error
  * @extends Error
  */
  */
 export default class CKEditorError extends Error {
 export default class CKEditorError extends Error {
 	/**
 	/**
 	 * Creates an instance of the CKEditorError class.
 	 * Creates an instance of the CKEditorError class.
 	 *
 	 *
-	 * Read more about error logging in the {@link utils.log} module.
+	 * Read more about error logging in the {@link @module:utils/log} module.
 	 *
 	 *
 	 * @param {String} message The error message in an `error-name: Error message.` format.
 	 * @param {String} message The error message in an `error-name: Error message.` format.
 	 * During the minification process the "Error message" part will be removed to limit the code size
 	 * During the minification process the "Error message" part will be removed to limit the code size
@@ -35,14 +37,14 @@ export default class CKEditorError extends Error {
 		super( message );
 		super( message );
 
 
 		/**
 		/**
-		 * @member {String} utils.CKEditorError#name
+		 * @member {String} name
 		 */
 		 */
 		this.name = 'CKEditorError';
 		this.name = 'CKEditorError';
 
 
 		/**
 		/**
 		 * The additional error data passed to the constructor.
 		 * The additional error data passed to the constructor.
 		 *
 		 *
-		 * @member {Object} utils.CKEditorError#data
+		 * @member {Object} data
 		 */
 		 */
 		this.data = data;
 		this.data = data;
 	}
 	}

+ 8 - 5
packages/ckeditor5-utils/src/collection.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  * For licensing, see LICENSE.md.
  */
  */
 
 
+/**
+ * @module utils/collection
+ */
+
 import EmitterMixin from './emittermixin.js';
 import EmitterMixin from './emittermixin.js';
 import CKEditorError from './ckeditorerror.js';
 import CKEditorError from './ckeditorerror.js';
 import uid from './uid.js';
 import uid from './uid.js';
@@ -18,7 +22,6 @@ import mix from './mix.js';
  * By default an item in the collection is identified by its `id` property. The name of the identifier can be
  * By default an item in the collection is identified by its `id` property. The name of the identifier can be
  * configured through the constructor of the collection.
  * configured through the constructor of the collection.
  *
  *
- * @memberOf utils
  * @mixes EventEmitter
  * @mixes EventEmitter
  */
  */
 export default class Collection {
 export default class Collection {
@@ -73,7 +76,7 @@ export default class Collection {
 	 * @param {Object} item
 	 * @param {Object} item
 	 * @param {Number} [index] The position of the item in the collection. The item
 	 * @param {Number} [index] The position of the item in the collection. The item
 	 * is pushed to the collection when `index` not specified.
 	 * is pushed to the collection when `index` not specified.
-	 * @fires utils.Collection#add
+	 * @fires #add
 	 */
 	 */
 	add( item, index ) {
 	add( item, index ) {
 		let itemId;
 		let itemId;
@@ -155,7 +158,7 @@ export default class Collection {
 	 *
 	 *
 	 * @param {Object|Number|String} subject The item to remove, its id or index in the collection.
 	 * @param {Object|Number|String} subject The item to remove, its id or index in the collection.
 	 * @returns {Object} The removed item.
 	 * @returns {Object} The removed item.
-	 * @fires utils.Collection#remove
+	 * @fires #remove
 	 */
 	 */
 	remove( subject ) {
 	remove( subject ) {
 		let index, id, item;
 		let index, id, item;
@@ -279,13 +282,13 @@ mix( Collection, EmitterMixin );
 /**
 /**
  * Fired when an item is added to the collection.
  * Fired when an item is added to the collection.
  *
  *
- * @event utils.Collection#add
+ * @event module:utils/collection~Collection#add
  * @param {Object} item The added item.
  * @param {Object} item The added item.
  */
  */
 
 
 /**
 /**
  * Fired when an item is removed from the collection.
  * Fired when an item is removed from the collection.
  *
  *
- * @event utils.Collection#remove
+ * @event module:utils/collection~Collection#remove
  * @param {Object} item The removed item.
  * @param {Object} item The removed item.
  */
  */

+ 4 - 0
packages/ckeditor5-utils/src/comparearrays.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  * For licensing, see LICENSE.md.
  */
  */
 
 
+/**
+ * @module utils/comparearrays
+ */
+
 /**
 /**
  * Compares how given arrays relate to each other. One array can be: same as another array, prefix of another array
  * Compares how given arrays relate to each other. One array can be: same as another array, prefix of another array
  * or completely different. If arrays are different, first index at which they differ is returned. Otherwise,
  * or completely different. If arrays are different, first index at which they differ is returned. Otherwise,

+ 4 - 2
packages/ckeditor5-utils/src/config.js

@@ -3,12 +3,14 @@
  * For licensing, see LICENSE.md.
  * For licensing, see LICENSE.md.
  */
  */
 
 
+/**
+ * @module utils/config
+ */
+
 import isPlainObject from './lib/lodash/isPlainObject.js';
 import isPlainObject from './lib/lodash/isPlainObject.js';
 
 
 /**
 /**
  * Handles a configuration dictionary.
  * Handles a configuration dictionary.
- *
- * @memberOf utils
  */
  */
 export default class Config {
 export default class Config {
 	/**
 	/**

+ 4 - 0
packages/ckeditor5-utils/src/count.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  * For licensing, see LICENSE.md.
  */
  */
 
 
+/**
+ * @module utils/count
+ */
+
 /**
 /**
  * Returns the number of items return by the iterator.
  * Returns the number of items return by the iterator.
  *
  *

+ 4 - 1
packages/ckeditor5-utils/src/diff.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  * For licensing, see LICENSE.md.
  */
  */
 
 
+/**
+ * @module utils/diff
+ */
+
 // The following code is based on the "O(NP) Sequence Comparison Algorithm"
 // The following code is based on the "O(NP) Sequence Comparison Algorithm"
 // by Sun Wu, Udi Manber, Gene Myers, Webb Miller.
 // by Sun Wu, Udi Manber, Gene Myers, Webb Miller.
 
 
@@ -12,7 +16,6 @@
  *
  *
  *		diff( 'aba', 'acca' ); // [ 'equal', 'insert', 'insert', 'delete', 'equal' ]
  *		diff( 'aba', 'acca' ); // [ 'equal', 'insert', 'insert', 'delete', 'equal' ]
  *
  *
- * @method utils.diff
  * @param {Array|String} a Input array or string.
  * @param {Array|String} a Input array or string.
  * @param {Array|String} b Output array or string.
  * @param {Array|String} b Output array or string.
  * @param {Function} [cmp] Optional function used to compare array values, by default === is used.
  * @param {Function} [cmp] Optional function used to compare array values, by default === is used.

+ 4 - 0
packages/ckeditor5-utils/src/difftochanges.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  * For licensing, see LICENSE.md.
  */
  */
 
 
+/**
+ * @module utils/difftochanges
+ */
+
 /**
 /**
  * Creates a set of changes which need to be applied to the input in order to transform
  * Creates a set of changes which need to be applied to the input in order to transform
  * it into the output. This function can be used with strings or arrays.
  * it into the output. This function can be used with strings or arrays.

+ 4 - 0
packages/ckeditor5-utils/src/dom/createelement.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  * For licensing, see LICENSE.md.
  */
  */
 
 
+/**
+ * @module utils/dom/createelement
+ */
+
 import isString from '../lib/lodash/isString.js';
 import isString from '../lib/lodash/isString.js';
 import isIterable from '../isiterable.js';
 import isIterable from '../isiterable.js';
 
 

+ 4 - 0
packages/ckeditor5-utils/src/dom/getancestors.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  * For licensing, see LICENSE.md.
  */
  */
 
 
+/**
+ * @module utils/dom/getancestors
+ */
+
 /* globals Node */
 /* globals Node */
 
 
 /**
 /**

+ 4 - 0
packages/ckeditor5-utils/src/dom/getcommonancestor.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  * For licensing, see LICENSE.md.
  */
  */
 
 
+/**
+ * @module utils/dom/getcommonancestor
+ */
+
 import getAncestors from './getancestors.js';
 import getAncestors from './getancestors.js';
 
 
 /**
 /**

+ 4 - 0
packages/ckeditor5-utils/src/dom/getdatafromelement.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  * For licensing, see LICENSE.md.
  */
  */
 
 
+/**
+ * @module utils/dom/getdatafromelement
+ */
+
 /* globals HTMLTextAreaElement */
 /* globals HTMLTextAreaElement */
 
 
 /**
 /**

+ 4 - 0
packages/ckeditor5-utils/src/dom/indexof.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  * For licensing, see LICENSE.md.
  */
  */
 
 
+/**
+ * @module utils/dom/indexof
+ */
+
 /**
 /**
  * Returns index of the node in the parent element.
  * Returns index of the node in the parent element.
  *
  *

+ 4 - 0
packages/ckeditor5-utils/src/dom/insertat.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  * For licensing, see LICENSE.md.
  */
  */
 
 
+/**
+ * @module utils/dom/insertat
+ */
+
 /**
 /**
  * Inserts node to the parent at given index.
  * Inserts node to the parent at given index.
  *
  *

+ 4 - 0
packages/ckeditor5-utils/src/dom/remove.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  * For licensing, see LICENSE.md.
  */
  */
 
 
+/**
+ * @module utils/dom/remove
+ */
+
 /**
 /**
  * Removes given node from parent.
  * Removes given node from parent.
  *
  *

+ 4 - 0
packages/ckeditor5-utils/src/dom/setdatainelement.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  * For licensing, see LICENSE.md.
  */
  */
 
 
+/**
+ * @module utils/dom/setdatainelement
+ */
+
 /* globals HTMLTextAreaElement */
 /* globals HTMLTextAreaElement */
 
 
 /**
 /**

+ 4 - 0
packages/ckeditor5-utils/src/dom/tounit.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  * For licensing, see LICENSE.md.
  */
  */
 
 
+/**
+ * @module utils/dom/tounit
+ */
+
 /**
 /**
  * Returns a helper function, which adds a desired trailing
  * Returns a helper function, which adds a desired trailing
  * `unit` to the passed value.
  * `unit` to the passed value.

+ 4 - 2
packages/ckeditor5-utils/src/elementreplacer.js

@@ -3,11 +3,13 @@
  * For licensing, see LICENSE.md.
  * For licensing, see LICENSE.md.
  */
  */
 
 
+/**
+ * @module utils/elementreplacer
+ */
+
 /**
 /**
  * Utility class allowing to hide existing HTML elements or replace them with given ones in a way that doesn't remove
  * Utility class allowing to hide existing HTML elements or replace them with given ones in a way that doesn't remove
  * the original elements from the DOM.
  * the original elements from the DOM.
- *
- * @memberOf utils
  */
  */
 export default class ElementReplacer {
 export default class ElementReplacer {
 	constructor() {
 	constructor() {

+ 4 - 0
packages/ckeditor5-utils/src/emittermixin.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  * For licensing, see LICENSE.md.
  */
  */
 
 
+/**
+ * @module utils/emittermixin
+ */
+
 import EventInfo from './eventinfo.js';
 import EventInfo from './eventinfo.js';
 import uid from './uid.js';
 import uid from './uid.js';
 import priorities from './priorities.js';
 import priorities from './priorities.js';

+ 6 - 4
packages/ckeditor5-utils/src/env.js

@@ -5,18 +5,20 @@
 
 
 /* globals navigator:false */
 /* globals navigator:false */
 
 
+/**
+ * @module utils/env
+ */
+
 const userAgent = navigator.userAgent.toLowerCase();
 const userAgent = navigator.userAgent.toLowerCase();
 
 
 /**
 /**
  * A namespace containing environment and browser information.
  * A namespace containing environment and browser information.
- *
- * @namespace utils.env
  */
  */
 export default {
 export default {
 	/**
 	/**
 	 * Indicates that application is running on Macintosh.
 	 * Indicates that application is running on Macintosh.
 	 *
 	 *
-	 * @member {Boolean} utils.env.mac
+	 * @member {Boolean}
 	 */
 	 */
 	mac: isMac( userAgent )
 	mac: isMac( userAgent )
 };
 };
@@ -24,7 +26,7 @@ export default {
 /**
 /**
  * Checks if User Agent represented by the string is running on Macintosh.
  * Checks if User Agent represented by the string is running on Macintosh.
  *
  *
- * @function utils.env.isMac
+ * @function isMac
  * @param {String} userAgent **Lowercase** `navigator.userAgent` string.
  * @param {String} userAgent **Lowercase** `navigator.userAgent` string.
  * @returns {Boolean} Whether User Agent is running on Macintosh or not.
  * @returns {Boolean} Whether User Agent is running on Macintosh or not.
  */
  */

+ 9 - 7
packages/ckeditor5-utils/src/eventinfo.js

@@ -3,34 +3,36 @@
  * For licensing, see LICENSE.md.
  * For licensing, see LICENSE.md.
  */
  */
 
 
+/**
+ * @module utils/eventinfo
+ */
+
 import spy from './spy.js';
 import spy from './spy.js';
 
 
 /**
 /**
  * The event object passed to event callbacks. It is used to provide information about the event as well as a tool to
  * The event object passed to event callbacks. It is used to provide information about the event as well as a tool to
  * manipulate it.
  * manipulate it.
- *
- * @memberOf utils
  */
  */
 export default class EventInfo {
 export default class EventInfo {
 	constructor( source, name ) {
 	constructor( source, name ) {
 		/**
 		/**
 		 * The object that fired the event.
 		 * The object that fired the event.
 		 *
 		 *
-		 * @member utils.EventInfo#source
+		 * @member #source
 		 */
 		 */
 		this.source = source;
 		this.source = source;
 
 
 		/**
 		/**
 		 * The event name.
 		 * The event name.
 		 *
 		 *
-		 * @member utils.EventInfo#name
+		 * @member #name
 		 */
 		 */
 		this.name = name;
 		this.name = name;
 
 
 		/**
 		/**
 		 * Path this event has followed. See {@link utils.EmitterMixin#delegate}.
 		 * Path this event has followed. See {@link utils.EmitterMixin#delegate}.
 		 *
 		 *
-		 * @member utils.EventInfo#path
+		 * @member #path
 		 */
 		 */
 		this.path = [];
 		this.path = [];
 
 
@@ -39,14 +41,14 @@ export default class EventInfo {
 		/**
 		/**
 		 * Stops the event emitter to call further callbacks for this event interaction.
 		 * Stops the event emitter to call further callbacks for this event interaction.
 		 *
 		 *
-		 * @method utils.EventInfo#stop
+		 * @method #stop
 		 */
 		 */
 		this.stop = spy();
 		this.stop = spy();
 
 
 		/**
 		/**
 		 * Removes the current callback from future interactions of this event.
 		 * Removes the current callback from future interactions of this event.
 		 *
 		 *
-		 * @method utils.EventInfo#off
+		 * @method #off
 		 */
 		 */
 		this.off = spy();
 		this.off = spy();
 	}
 	}

+ 4 - 1
packages/ckeditor5-utils/src/focustracker.js

@@ -5,6 +5,10 @@
 
 
 /* global setTimeout, clearTimeout */
 /* global setTimeout, clearTimeout */
 
 
+/**
+ * @module utils/focustracker
+ */
+
 import DOMEmitterMixin from '../ui/domemittermixin.js';
 import DOMEmitterMixin from '../ui/domemittermixin.js';
 import ObservableMixin from './observablemixin.js';
 import ObservableMixin from './observablemixin.js';
 import CKEditorError from './ckeditorerror.js';
 import CKEditorError from './ckeditorerror.js';
@@ -20,7 +24,6 @@ import mix from './mix.js';
  * which contain other `focusable` elements. But note that this wrapper element has to be focusable too
  * which contain other `focusable` elements. But note that this wrapper element has to be focusable too
  * (have e.g. `tabindex="-1"`).
  * (have e.g. `tabindex="-1"`).
  *
  *
- * @memberOf utils
  * @mixes utils.DOMEmitterMixin
  * @mixes utils.DOMEmitterMixin
  * @mixes utils.ObservableMixin
  * @mixes utils.ObservableMixin
  */
  */

+ 4 - 0
packages/ckeditor5-utils/src/isiterable.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  * For licensing, see LICENSE.md.
  */
  */
 
 
+/**
+ * @module utils/isiterable
+ */
+
 /**
 /**
  * Checks if value implements iterator interface.
  * Checks if value implements iterator interface.
  *
  *

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

@@ -3,15 +3,15 @@
  * For licensing, see LICENSE.md.
  * For licensing, see LICENSE.md.
  */
  */
 
 
-import CKEditorError from './ckeditorerror.js';
-import env from './env.js';
-
 /**
 /**
  * Set of utils related to keyboard support.
  * Set of utils related to keyboard support.
  *
  *
- * @namespace utils.keyboard
+ * @module utils/keyboard
  */
  */
 
 
+import CKEditorError from './ckeditorerror.js';
+import env from './env.js';
+
 /**
 /**
  * Object with `keyName => keyCode` pairs for a set of known keys.
  * Object with `keyName => keyCode` pairs for a set of known keys.
  *
  *
@@ -23,17 +23,17 @@ import env from './env.js';
  * * `backspace`, `delete`, `enter`, `esc`, `tab`,
  * * `backspace`, `delete`, `enter`, `esc`, `tab`,
  * * `ctrl`, `cmd`, `shift`, `alt`.
  * * `ctrl`, `cmd`, `shift`, `alt`.
  *
  *
- * @member {Object} utils.keyboard.keyCodes
+ * @member {Object} module:utils/keyboard~keyCodes
  */
  */
 export const keyCodes = generateKnownKeyCodes();
 export const keyCodes = generateKnownKeyCodes();
 
 
 /**
 /**
- * Converts a key name or a {@link utils.keyboard.KeystrokeInfo keystroke info} into a key code.
+ * Converts a key name or a {@link module:utils/keyboard~KeystrokeInfo keystroke info} into a key code.
  *
  *
- * Note: Key names are matched with {@link utils.keyboard.keyCodes} in a case-insensitive way.
+ * Note: Key names are matched with {@link module:utils/keyboard~keyCodes} in a case-insensitive way.
  *
  *
- * @method utils.keyboard.getCode
- * @param {String|utils.keyboard.KeystrokeInfo} Key name (see {@link utils.keyboard.keyCodes})
+ * @method module:utils/keyboard.getCode
+ * @param {String|module:utils/keyboard~KeystrokeInfo} Key name (see {@link module:utils/keyboard~keyCodes})
  * or a keystroke data object.
  * or a keystroke data object.
  * @returns {Number} Key or keystroke code.
  * @returns {Number} Key or keystroke code.
  */
  */
@@ -45,7 +45,7 @@ export function getCode( key ) {
 
 
 		if ( !keyCode ) {
 		if ( !keyCode ) {
 			/**
 			/**
-			 * Unknown key name. Only key names contained by the {@link utils.keyboard.keyCodes} can be used.
+			 * Unknown key name. Only key names contained by the {@link module:utils/keyboard~keyCodes} can be used.
 			 *
 			 *
 			 * @errror keyboard-unknown-key
 			 * @errror keyboard-unknown-key
 			 * @param {String} key
 			 * @param {String} key
@@ -64,20 +64,20 @@ export function getCode( key ) {
 
 
 /**
 /**
  * Parses keystroke and returns a keystroke code that will match the code returned by
  * Parses keystroke and returns a keystroke code that will match the code returned by
- * link {@link utils.keyboard.getCode} for a corresponding {@link utils.keyboard.KeystrokeInfo keystroke info}.
+ * link {@link module:utils/keyboard.getCode} for a corresponding {@link module:utils/keyboard~KeystrokeInfo keystroke info}.
  *
  *
  * The keystroke can be passed in two formats:
  * The keystroke can be passed in two formats:
  *
  *
  * * as a single string – e.g. `ctrl + A`,
  * * as a single string – e.g. `ctrl + A`,
- * * as an array of {@link utils.keyboard.keyCodes known key names} and key codes – e.g.:
+ * * as an array of {@link module:utils/keyboard~keyCodes known key names} and key codes – e.g.:
  *   * `[ 'ctrl', 32 ]` (ctrl + space),
  *   * `[ 'ctrl', 32 ]` (ctrl + space),
  *   * `[ 'ctrl', 'a' ]` (ctrl + A).
  *   * `[ 'ctrl', 'a' ]` (ctrl + A).
  *
  *
- * Note: Key names are matched with {@link utils.keyboard.keyCodes} in a case-insensitive way.
+ * Note: Key names are matched with {@link module:utils/keyboard~keyCodes} in a case-insensitive way.
  *
  *
  * Note: Only keystrokes with a single non-modifier key are supported (e.g. `ctrl+A` is OK, but `ctrl+A+B` is not).
  * Note: Only keystrokes with a single non-modifier key are supported (e.g. `ctrl+A` is OK, but `ctrl+A+B` is not).
  *
  *
- * @method utils.keyboard.parseKeystroke
+ * @method module:utils/keyboard~parseKeystroke
  * @param {String|Array.<Number|String>} keystroke Keystroke definition.
  * @param {String|Array.<Number|String>} keystroke Keystroke definition.
  * @returns {Number} Keystroke code.
  * @returns {Number} Keystroke code.
  */
  */
@@ -95,7 +95,7 @@ export function parseKeystroke( keystroke ) {
  * It translates any keystroke string text like `"CTRL+A"` to an
  * It translates any keystroke string text like `"CTRL+A"` to an
  * environment–specific keystroke, i.e. `"⌘A"` on Mac OSX.
  * environment–specific keystroke, i.e. `"⌘A"` on Mac OSX.
  *
  *
- * @method utils.keyboard.getEnvKeystrokeText
+ * @method module:utils/keyboard~getEnvKeystrokeText
  * @param {String} keystroke Keystroke text.
  * @param {String} keystroke Keystroke text.
  * @returns {String} Keystroke text specific for the environment.
  * @returns {String} Keystroke text specific for the environment.
  */
  */
@@ -155,29 +155,29 @@ function splitKeystrokeText( keystroke ) {
 /**
 /**
  * Information about a keystroke.
  * Information about a keystroke.
  *
  *
- * @interface utils.keyboard.KeystrokeInfo
+ * @interface module:utils/keyboard~KeystrokeInfo
  */
  */
 
 
 /**
 /**
  * The [key code](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/keyCode).
  * The [key code](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/keyCode).
  *
  *
- * @member {Number} utils.keyboard.KeystrokeInfo#keyCode
+ * @member {Number} module:utils/keyboard~KeystrokeInfo#keyCode
  */
  */
 
 
 /**
 /**
  * Whether the <kbd>Alt</kbd> modifier was pressed.
  * Whether the <kbd>Alt</kbd> modifier was pressed.
  *
  *
- * @member {Bolean} utils.keyboard.KeystrokeInfo#altKey
+ * @member {Bolean} module:utils/keyboard~KeystrokeInfo#altKey
  */
  */
 
 
 /**
 /**
  * Whether the <kbd>Ctrl</kbd> or <kbd>Cmd</kbd> modifier was pressed.
  * Whether the <kbd>Ctrl</kbd> or <kbd>Cmd</kbd> modifier was pressed.
  *
  *
- * @member {Bolean} utils.keyboard.KeystrokeInfo#ctrlKey
+ * @member {Bolean} module:utils/keyboard~KeystrokeInfo#ctrlKey
  */
  */
 
 
 /**
 /**
  * Whether the <kbd>Shift</kbd> modifier was pressed.
  * Whether the <kbd>Shift</kbd> modifier was pressed.
  *
  *
- * @member {Bolean} utils.keyboard.KeystrokeInfo#shiftKey
+ * @member {Bolean} module:utils/keyboard~KeystrokeInfo#shiftKey
  */
  */

+ 4 - 2
packages/ckeditor5-utils/src/locale.js

@@ -3,10 +3,12 @@
  * For licensing, see LICENSE.md.
  * For licensing, see LICENSE.md.
  */
  */
 
 
+/**
+ * @module utils/locale
+ */
+
 /**
 /**
  * Represents the localization services.
  * Represents the localization services.
- *
- * @memberOf utils
  */
  */
 export default class Locale {
 export default class Locale {
 	/**
 	/**

+ 4 - 0
packages/ckeditor5-utils/src/log.js

@@ -5,6 +5,10 @@
 
 
 /* global console */
 /* global console */
 
 
+/**
+ * @module utils/log
+ */
+
 /**
 /**
  * The logging module.
  * The logging module.
  *
  *

+ 4 - 0
packages/ckeditor5-utils/src/mapsequal.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  * For licensing, see LICENSE.md.
  */
  */
 
 
+/**
+ * @module utils/mapsequal
+ */
+
 /**
 /**
  * Checks whether given {Map}s are equal, that is has same size and same key-value pairs.
  * Checks whether given {Map}s are equal, that is has same size and same key-value pairs.
  *
  *

+ 4 - 0
packages/ckeditor5-utils/src/mix.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  * For licensing, see LICENSE.md.
  */
  */
 
 
+/**
+ * @module utils/mix
+ */
+
 /**
 /**
  * Copies enumerable properties and symbols from the objects given as 2nd+ parameters to the
  * Copies enumerable properties and symbols from the objects given as 2nd+ parameters to the
  * prototype of first object (a constructor).
  * prototype of first object (a constructor).

+ 4 - 0
packages/ckeditor5-utils/src/nth.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  * For licensing, see LICENSE.md.
  */
  */
 
 
+/**
+ * @module utils/nth
+ */
+
 /**
 /**
  * Returns `nth` (starts from `0` of course) item of an `iterable`.
  * Returns `nth` (starts from `0` of course) item of an `iterable`.
  *
  *

+ 4 - 0
packages/ckeditor5-utils/src/objecttomap.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  * For licensing, see LICENSE.md.
  */
  */
 
 
+/**
+ * @module utils/objecttomap
+ */
+
 /**
 /**
  * Transforms object to map.
  * Transforms object to map.
  *
  *

+ 9 - 5
packages/ckeditor5-utils/src/observablemixin.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  * For licensing, see LICENSE.md.
  */
  */
 
 
+/**
+ * @module module:observablemixin
+ */
+
 import EmitterMixin from './emittermixin.js';
 import EmitterMixin from './emittermixin.js';
 import CKEditorError from './ckeditorerror.js';
 import CKEditorError from './ckeditorerror.js';
 import extend from './lib/lodash/extend.js';
 import extend from './lib/lodash/extend.js';
@@ -16,8 +20,8 @@ const boundAttributesSymbol = Symbol( 'boundAttributes' );
  * Mixin that injects the "observable attributes" and data binding functionality.
  * Mixin that injects the "observable attributes" and data binding functionality.
  * Used mainly in the {@link ui.Model} class.
  * Used mainly in the {@link ui.Model} class.
  *
  *
- * @mixin utils.ObservableMixin
- * @mixes utils.EmitterMixin
+ * @mixin ObservableMixin
+ * @mixes module:utils/emittermixin~EmitterMixin
  * @implements utils.Observable
  * @implements utils.Observable
  */
  */
 const ObservableMixin = {
 const ObservableMixin = {
@@ -31,7 +35,7 @@ const ObservableMixin = {
 	 * have a property with a given attribute name. This prevents from mistakenly overriding existing
 	 * have a property with a given attribute name. This prevents from mistakenly overriding existing
 	 * properties and methods, but means that `foo.set( 'bar', 1 )` may be slightly slower than `foo.bar = 1`.
 	 * properties and methods, but means that `foo.set( 'bar', 1 )` may be slightly slower than `foo.bar = 1`.
 	 *
 	 *
-	 * @method utils.ObservableMixin#set
+	 * @method #set
 	 * @param {String} name The attributes name.
 	 * @param {String} name The attributes name.
 	 * @param {*} value The attributes value.
 	 * @param {*} value The attributes value.
 	 */
 	 */
@@ -99,14 +103,14 @@ const ObservableMixin = {
 	 * of the observable it is bound to and react to the changes to these attributes
 	 * of the observable it is bound to and react to the changes to these attributes
 	 * in the future.
 	 * in the future.
 	 *
 	 *
-	 * **Note**: To release the binding use {@link utils.ObservableMixin#unbind}.
+	 * **Note**: To release the binding use {@link #unbind}.
 	 *
 	 *
 	 *		A.bind( 'a' ).to( B );
 	 *		A.bind( 'a' ).to( B );
 	 *		A.bind( 'a' ).to( B, 'b' );
 	 *		A.bind( 'a' ).to( B, 'b' );
 	 *		A.bind( 'a', 'b' ).to( B, 'c', 'd' );
 	 *		A.bind( 'a', 'b' ).to( B, 'c', 'd' );
 	 *		A.bind( 'a' ).to( B, 'b', C, 'd', ( b, d ) => b + d );
 	 *		A.bind( 'a' ).to( B, 'b', C, 'd', ( b, d ) => b + d );
 	 *
 	 *
-	 * @method utils.ObservableMixin#bind
+	 * @method #bind
 	 * @param {...String} bindAttrs Observable attributes that will be bound to another observable(s).
 	 * @param {...String} bindAttrs Observable attributes that will be bound to another observable(s).
 	 * @returns {utils.BindChain}
 	 * @returns {utils.BindChain}
 	 */
 	 */

+ 4 - 2
packages/ckeditor5-utils/src/priorities.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  * For licensing, see LICENSE.md.
  */
  */
 
 
+/**
+ * @module utils/priorites
+ */
+
 /**
 /**
  * String representing a priority value.
  * String representing a priority value.
  *
  *
@@ -11,8 +15,6 @@
 
 
 /**
 /**
  * Provides group of constants to use instead of hardcoding numeric priority values.
  * Provides group of constants to use instead of hardcoding numeric priority values.
- *
- * @memberOf utils
  */
  */
 const priorities = {
 const priorities = {
 	/**
 	/**

+ 4 - 1
packages/ckeditor5-utils/src/spy.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  * For licensing, see LICENSE.md.
  */
  */
 
 
+/**
+ * @module utils/spy
+ */
+
 /**
 /**
  * Creates a spy function (ala Sinon.js) that can be used to inspect call to it.
  * Creates a spy function (ala Sinon.js) that can be used to inspect call to it.
  *
  *
@@ -10,7 +14,6 @@
  *
  *
  * * spy.called: property set to `true` if the function has been called at least once.
  * * spy.called: property set to `true` if the function has been called at least once.
  *
  *
- * @memberOf utils
  * @returns {Function} The spy function.
  * @returns {Function} The spy function.
  */
  */
 export default function spy() {
 export default function spy() {

+ 4 - 1
packages/ckeditor5-utils/src/tomap.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  * For licensing, see LICENSE.md.
  */
  */
 
 
+/**
+ * @module utils/toMap
+ */
+
 import isPlainObject from './lib/lodash/isPlainObject.js';
 import isPlainObject from './lib/lodash/isPlainObject.js';
 import objectToMap from './objecttomap.js';
 import objectToMap from './objecttomap.js';
 
 
@@ -13,7 +17,6 @@ import objectToMap from './objecttomap.js';
  *		map = toMap( [ [ 'foo', 1 ], [ 'bar', 2 ] ] );
  *		map = toMap( [ [ 'foo', 1 ], [ 'bar', 2 ] ] );
  *		map = toMap( anotherMap );
  *		map = toMap( anotherMap );
  *
  *
- * @memberOf utils
  * @param {Object|Iterable} data Object or iterable to transform.
  * @param {Object|Iterable} data Object or iterable to transform.
  * @returns {Map} Map created from data.
  * @returns {Map} Map created from data.
  */
  */

+ 4 - 1
packages/ckeditor5-utils/src/uid.js

@@ -3,12 +3,15 @@
  * For licensing, see LICENSE.md.
  * For licensing, see LICENSE.md.
  */
  */
 
 
+/**
+ * @module utils/uid
+ */
+
 /**
 /**
  * Returns a unique id. This id is a number (starting from 1) which will never get repeated on successive calls
  * Returns a unique id. This id is a number (starting from 1) which will never get repeated on successive calls
  * to this method.
  * to this method.
  *
  *
  * @function
  * @function
- * @memberOf utils
  * @returns {Number} A number representing the id.
  * @returns {Number} A number representing the id.
  */
  */
 export default ( () => {
 export default ( () => {

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

@@ -6,7 +6,7 @@
 /**
 /**
  * Set of utils to handle unicode characters.
  * Set of utils to handle unicode characters.
  *
  *
- * @namespace utils.unicode
+ * @module utils/unicode
  */
  */
 
 
 /**
 /**