Răsfoiți Sursa

Docs fixes.

Maciek 9 ani în urmă
părinte
comite
ea7208747f
28 a modificat fișierele cu 94 adăugiri și 102 ștergeri
  1. 2 2
      packages/ckeditor5-utils/src/ckeditorerror.js
  2. 1 1
      packages/ckeditor5-utils/src/collection.js
  3. 1 2
      packages/ckeditor5-utils/src/comparearrays.js
  4. 2 2
      packages/ckeditor5-utils/src/config.js
  5. 0 1
      packages/ckeditor5-utils/src/count.js
  6. 2 2
      packages/ckeditor5-utils/src/difftochanges.js
  7. 0 1
      packages/ckeditor5-utils/src/dom/createelement.js
  8. 2 2
      packages/ckeditor5-utils/src/dom/getancestors.js
  9. 3 3
      packages/ckeditor5-utils/src/dom/getdatafromelement.js
  10. 1 1
      packages/ckeditor5-utils/src/dom/indexof.js
  11. 1 1
      packages/ckeditor5-utils/src/dom/insertat.js
  12. 1 1
      packages/ckeditor5-utils/src/dom/remove.js
  13. 1 1
      packages/ckeditor5-utils/src/dom/setdatainelement.js
  14. 3 3
      packages/ckeditor5-utils/src/dom/tounit.js
  15. 2 1
      packages/ckeditor5-utils/src/elementreplacer.js
  16. 28 27
      packages/ckeditor5-utils/src/emittermixin.js
  17. 1 1
      packages/ckeditor5-utils/src/eventinfo.js
  18. 10 10
      packages/ckeditor5-utils/src/focustracker.js
  19. 0 1
      packages/ckeditor5-utils/src/isiterable.js
  20. 4 4
      packages/ckeditor5-utils/src/locale.js
  21. 5 7
      packages/ckeditor5-utils/src/log.js
  22. 0 1
      packages/ckeditor5-utils/src/mapsequal.js
  23. 0 1
      packages/ckeditor5-utils/src/mix.js
  24. 0 1
      packages/ckeditor5-utils/src/nth.js
  25. 0 1
      packages/ckeditor5-utils/src/objecttomap.js
  26. 20 20
      packages/ckeditor5-utils/src/observablemixin.js
  27. 3 3
      packages/ckeditor5-utils/src/priorities.js
  28. 1 1
      packages/ckeditor5-utils/src/uid.js

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

@@ -11,7 +11,7 @@
  * 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 @module:utils/log}.
+ * Therefore, all error messages should be documented in the same way as those in {@link module:utils/log}.
  *
  *
  * Read more in the {@link module:utils/log} module.
  * Read more in the {@link module:utils/log} module.
  * @extends Error
  * @extends Error
@@ -20,7 +20,7 @@ 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 @module: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

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

@@ -76,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 #add
+	 * @fires add
 	 */
 	 */
 	add( item, index ) {
 	add( item, index ) {
 		let itemId;
 		let itemId;

+ 1 - 2
packages/ckeditor5-utils/src/comparearrays.js

@@ -19,10 +19,9 @@
  *		compareArrays( [ 0, 2 ], [ 1, 2 ] );		// 0
  *		compareArrays( [ 0, 2 ], [ 1, 2 ] );		// 0
  *		compareArrays( [ 0, 2 ], [ 0, 1 ] );		// 1
  *		compareArrays( [ 0, 2 ], [ 0, 1 ] );		// 1
  *
  *
- * @memberOf utils
  * @param {Array} a Array that is compared.
  * @param {Array} a Array that is compared.
  * @param {Array} b Array to compare with.
  * @param {Array} b Array to compare with.
- * @returns {utils.ArrayRelation} How array `a` is related to `b`.
+ * @returns {ArrayRelation} How array `a` is related to `b`.
  */
  */
 export default function compareArrays( a, b ) {
 export default function compareArrays( a, b ) {
 	const minLen = Math.min( a.length, b.length );
 	const minLen = Math.min( a.length, b.length );

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

@@ -14,7 +14,7 @@ import isPlainObject from './lib/lodash/isPlainObject.js';
  */
  */
 export default class Config {
 export default class Config {
 	/**
 	/**
-	 * Creates an instance of the {@link Config} class.
+	 * Creates an instance of the {@link ~Config} class.
 	 *
 	 *
 	 * @param {Object} [configurations] The initial configurations to be set.
 	 * @param {Object} [configurations] The initial configurations to be set.
 	 */
 	 */
@@ -23,7 +23,7 @@ export default class Config {
 		 * Store for the whole configuration.
 		 * Store for the whole configuration.
 		 *
 		 *
 		 * @private
 		 * @private
-		 * @member {Object} utils.config#_config
+		 * @member {Object} #_config
 		 */
 		 */
 		this._config = {};
 		this._config = {};
 
 

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

@@ -12,7 +12,6 @@
  *
  *
  *		count( [ 1, 2, 3, 4, 5 ] ); // 5;
  *		count( [ 1, 2, 3, 4, 5 ] ); // 5;
  *
  *
- * @memberOf utils
  * @param {Iterable.<*>} iterator Any iterator.
  * @param {Iterable.<*>} iterator Any iterator.
  * @returns {Number} Number of items returned by that iterator.
  * @returns {Number} Number of items returned by that iterator.
  */
  */

+ 2 - 2
packages/ckeditor5-utils/src/difftochanges.js

@@ -25,8 +25,8 @@
  *
  *
  *		input.join( '' ) == output.join( '' ); // -> true
  *		input.join( '' ) == output.join( '' ); // -> true
  *
  *
- * @method utils.diffToChanges
- * @param {Array.<'equal'|'insert'|'delete'>} diff Result of {@link utils.diff}.
+ * @method diffToChanges
+ * @param {Array.<'equal'|'insert'|'delete'>} diff Result of {@link module:utils/diff~diff}.
  * @param {String|Array} output The string or array which was passed as diff's output.
  * @param {String|Array} output The string or array which was passed as diff's output.
  * @returns {Array.<Object>} Set of changes (insert or delete) which need to be applied to the input
  * @returns {Array.<Object>} Set of changes (insert or delete) which need to be applied to the input
  * in order to transform it into the output.
  * in order to transform it into the output.

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

@@ -18,7 +18,6 @@ import isIterable from '../isiterable.js';
  *		createElement( document, 'p', null, 'foo' ); // <p>foo</p>
  *		createElement( document, 'p', null, 'foo' ); // <p>foo</p>
  *		createElement( document, 'p', null, [ 'foo', createElement( document, 'img' ) ] ); // <p>foo<img></p>
  *		createElement( document, 'p', null, [ 'foo', createElement( document, 'img' ) ] ); // <p>foo<img></p>
  *
  *
- * @method utils.dom.createElement
  * @param {Document} doc Document used to create element.
  * @param {Document} doc Document used to create element.
  * @param {String} name Name of the element.
  * @param {String} name Name of the element.
  * @param {Object} 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.

+ 2 - 2
packages/ckeditor5-utils/src/dom/getancestors.js

@@ -3,12 +3,12 @@
  * For licensing, see LICENSE.md.
  * For licensing, see LICENSE.md.
  */
  */
 
 
+/* globals Node */
+
 /**
 /**
  * @module utils/dom/getancestors
  * @module utils/dom/getancestors
  */
  */
 
 
-/* globals Node */
-
 /**
 /**
  * Returns all ancestors of given DOM node, starting from the top-most (root). Includes the given node itself. If the
  * Returns all ancestors of given DOM node, starting from the top-most (root). Includes the given node itself. If the
  * node is a part of `DocumentFragment` that `DocumentFragment` will be returned. In contrary, if the node is
  * node is a part of `DocumentFragment` that `DocumentFragment` will be returned. In contrary, if the node is

+ 3 - 3
packages/ckeditor5-utils/src/dom/getdatafromelement.js

@@ -3,16 +3,16 @@
  * For licensing, see LICENSE.md.
  * For licensing, see LICENSE.md.
  */
  */
 
 
+/* globals HTMLTextAreaElement */
+
 /**
 /**
  * @module utils/dom/getdatafromelement
  * @module utils/dom/getdatafromelement
  */
  */
 
 
-/* globals HTMLTextAreaElement */
-
 /**
 /**
  * Gets data from a given source element.
  * Gets data from a given source element.
  *
  *
- * @method utils.dom.getDataFromElement
+ * @method getDataFromElement
  * @param {HTMLElement} el The element from which the data will be retrieved.
  * @param {HTMLElement} el The element from which the data will be retrieved.
  * @returns {String} The data string.
  * @returns {String} The data string.
  */
  */

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

@@ -10,7 +10,7 @@
 /**
 /**
  * Returns index of the node in the parent element.
  * Returns index of the node in the parent element.
  *
  *
- * @method utils.dom.indexOf
+ * @method indexOf
  * @param {Node} node Node which index is tested.
  * @param {Node} node Node which index is tested.
  * @returns {Number} Index of the node in the parent element. Returns 0 if node has no parent.
  * @returns {Number} Index of the node in the parent element. Returns 0 if node has no parent.
  */
  */

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

@@ -10,7 +10,7 @@
 /**
 /**
  * Inserts node to the parent at given index.
  * Inserts node to the parent at given index.
  *
  *
- * @method utils.dom.insertAt
+ * @method insertAt
  * @param {Element} parentElement Parent element.
  * @param {Element} parentElement Parent element.
  * @param {Number} index Insertions index.
  * @param {Number} index Insertions index.
  * @param {Node} nodeToInsert Node to insert.
  * @param {Node} nodeToInsert Node to insert.

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

@@ -10,7 +10,7 @@
 /**
 /**
  * Removes given node from parent.
  * Removes given node from parent.
  *
  *
- * @method utils.dom.remove
+ * @method remove
  * @param {Node} node Node to remove.
  * @param {Node} node Node to remove.
  */
  */
 export default function remove( node ) {
 export default function remove( node ) {

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

@@ -12,7 +12,7 @@
 /**
 /**
  * Sets data in a given element.
  * Sets data in a given element.
  *
  *
- * @method utils.dom.setDataInElement
+ * @method setDataInElement
  * @param {HTMLElement} el The element in which the data will be set.
  * @param {HTMLElement} el The element in which the data will be set.
  * @param {String} data The data string.
  * @param {String} data The data string.
  */
  */

+ 3 - 3
packages/ckeditor5-utils/src/dom/tounit.js

@@ -11,16 +11,16 @@
  * 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.
  *
  *
- * @method utils.dom.toUnit
+ * @method toUnit
  * @param {String} unit An unit like "px" or "em".
  * @param {String} unit An unit like "px" or "em".
- * @returns {utils.dom.toUnit.helper}
+ * @returns {toUnit.helper}
  */
  */
 export default function toUnit( unit ) {
 export default function toUnit( unit ) {
 	/**
 	/**
 	 * A function, which adds a pre–defined trailing `unit`
 	 * A function, which adds a pre–defined trailing `unit`
 	 * to the passed `value`.
 	 * to the passed `value`.
 	 *
 	 *
-	 * @function utils.dom.toUnit.helper
+	 * @function helper
  	 * @param {*} value A value to be given the unit.
  	 * @param {*} value A value to be given the unit.
  	 * @returns {String} A value with the trailing unit.
  	 * @returns {String} A value with the trailing unit.
 	 */
 	 */

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

@@ -17,7 +17,7 @@ export default class ElementReplacer {
 		 * The elements replaced by {@link #replace} and their replacements.
 		 * The elements replaced by {@link #replace} and their replacements.
 		 *
 		 *
 		 * @private
 		 * @private
-		 * @member {Array.<Object>} utils.ElementReplacer#_replacedElements
+		 * @member {Array.<Object>} ~ElementReplacer#_replacedElements
 		 */
 		 */
 		this._replacedElements = [];
 		this._replacedElements = [];
 	}
 	}
@@ -29,6 +29,7 @@ export default class ElementReplacer {
 	 *
 	 *
 	 * @param {HTMLElement} element The element to replace.
 	 * @param {HTMLElement} element The element to replace.
 	 * @param {HTMLElement} [newElement] The replacement element. If not passed, then the `element` will just be hidden.
 	 * @param {HTMLElement} [newElement] The replacement element. If not passed, then the `element` will just be hidden.
+
 	 */
 	 */
 	replace( element, newElement ) {
 	replace( element, newElement ) {
 		this._replacedElements.push( { element, newElement } );
 		this._replacedElements.push( { element, newElement } );

+ 28 - 27
packages/ckeditor5-utils/src/emittermixin.js

@@ -14,8 +14,8 @@ import priorities from './priorities.js';
 /**
 /**
  * Mixin that injects the events API into its host.
  * Mixin that injects the events API into its host.
  *
  *
- * @mixin utils.EmitterMixin
- * @implements utils.Emitter
+ * @mixin EmitterMixin
+ * @implements  module:utils/emittermixin~Emitter
  */
  */
 const EmitterMixin = {
 const EmitterMixin = {
 	/**
 	/**
@@ -31,11 +31,12 @@ const EmitterMixin = {
 	 * @param {String} event The name of the event.
 	 * @param {String} event The name of the event.
 	 * @param {Function} callback The function to be called on event.
 	 * @param {Function} callback The function to be called on event.
 	 * @param {Object} [options={}] Additional options.
 	 * @param {Object} [options={}] Additional options.
-	 * @param {utils.PriorityString|Number} [options.priority='normal'] The priority of this event callback. The higher
+	 * @param {module:utils/priorities~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
 	 * the priority value the sooner the callback will be fired. Events having the same priority are called in the
 	 * order they were added.
 	 * order they were added.
+	 * -+
 	 * @param {Object} [options.context] The object that represents `this` in the callback. Defaults to the object firing the event.
 	 * @param {Object} [options.context] The object that represents `this` in the callback. Defaults to the object firing the event.
-	 * @method utils.EmitterMixin#on
+	 * @method #on
 	 */
 	 */
 	on( event, callback, options = {} ) {
 	on( event, callback, options = {} ) {
 		createEventNamespace( this, event );
 		createEventNamespace( this, event );
@@ -76,11 +77,11 @@ const EmitterMixin = {
 	 * @param {String} event The name of the event.
 	 * @param {String} event The name of the event.
 	 * @param {Function} callback The function to be called on event.
 	 * @param {Function} callback The function to be called on event.
 	 * @param {Object} [options={}] Additional options.
 	 * @param {Object} [options={}] Additional options.
-	 * @param {utils.PriorityString|Number} [options.priority='normal'] The priority of this event callback. The higher
+	 * @param {module:utils/priorities~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
 	 * the priority value the sooner the callback will be fired. Events having the same priority are called in the
 	 * order they were added.
 	 * order they were added.
 	 * @param {Object} [options.context] The object that represents `this` in the callback. Defaults to the object firing the event.
 	 * @param {Object} [options.context] The object that represents `this` in the callback. Defaults to the object firing the event.
-	 * @method utils.EmitterMixin#once
+	 * @method #once
 	 */
 	 */
 	once( event, callback, options ) {
 	once( event, callback, options ) {
 		const onceCallback = function( event ) {
 		const onceCallback = function( event ) {
@@ -102,7 +103,7 @@ const EmitterMixin = {
 	 * @param {Function} callback The function to stop being called.
 	 * @param {Function} callback The function to stop being called.
 	 * @param {Object} [context] The context object to be removed, pared with the given callback. To handle cases where
 	 * @param {Object} [context] The context object to be removed, pared with the given callback. To handle cases where
 	 * the same callback is used several times with different contexts.
 	 * the same callback is used several times with different contexts.
-	 * @method utils.EmitterMixin#off
+	 * @method #off
 	 */
 	 */
 	off( event, callback, context ) {
 	off( event, callback, context ) {
 		const lists = getCallbacksListsForNamespace( this, event );
 		const lists = getCallbacksListsForNamespace( this, event );
@@ -123,15 +124,15 @@ const EmitterMixin = {
 	/**
 	/**
 	 * Registers a callback function to be executed when an event is fired in a specific (emitter) object.
 	 * Registers a callback function to be executed when an event is fired in a specific (emitter) object.
 	 *
 	 *
-	 * @param {utils.Emitter} emitter The object that fires the event.
+	 * @param {module:utils/emittermixin~Emitter} emitter The object that fires the event.
 	 * @param {String} event The name of the event.
 	 * @param {String} event The name of the event.
 	 * @param {Function} callback The function to be called on event.
 	 * @param {Function} callback The function to be called on event.
 	 * @param {Object} [options={}] Additional options.
 	 * @param {Object} [options={}] Additional options.
-	 * @param {utils.PriorityString|Number} [options.priority='normal'] The priority of this event callback. The higher
+	 * @param {module:utils/priorities~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
 	 * the priority value the sooner the callback will be fired. Events having the same priority are called in the
 	 * order they were added.
 	 * order they were added.
 	 * @param {Object} [options.context] The object that represents `this` in the callback. Defaults to the object firing the event.
 	 * @param {Object} [options.context] The object that represents `this` in the callback. Defaults to the object firing the event.
-	 * @method utils.EmitterMixin#listenTo
+	 * @method #listenTo
 	 */
 	 */
 	listenTo( emitter, event, callback, options ) {
 	listenTo( emitter, event, callback, options ) {
 		let emitters, emitterId, emitterInfo, eventCallbacks;
 		let emitters, emitterId, emitterInfo, eventCallbacks;
@@ -183,12 +184,12 @@ const EmitterMixin = {
 	 * * To stop listening to all events fired by a specific object.
 	 * * To stop listening to all events fired by a specific object.
 	 * * To stop listening to all events fired by all object.
 	 * * To stop listening to all events fired by all object.
 	 *
 	 *
-	 * @param {utils.Emitter} [emitter] The object to stop listening to. If omitted, stops it for all objects.
+	 * @param {module:utils/emittermixin~Emitter} [emitter] The object to stop listening to. If omitted, stops it for all objects.
 	 * @param {String} [event] (Requires the `emitter`) The name of the event to stop listening to. If omitted, stops it
 	 * @param {String} [event] (Requires the `emitter`) The name of the event to stop listening to. If omitted, stops it
 	 * for all events from `emitter`.
 	 * for all events from `emitter`.
 	 * @param {Function} [callback] (Requires the `event`) The function to be removed from the call list for the given
 	 * @param {Function} [callback] (Requires the `event`) The function to be removed from the call list for the given
 	 * `event`.
 	 * `event`.
-	 * @method utils.EmitterMixin#stopListening
+	 * @method #stopListening
 	 */
 	 */
 	stopListening( emitter, event, callback ) {
 	stopListening( emitter, event, callback ) {
 		let emitters = this._listeningTo;
 		let emitters = this._listeningTo;
@@ -231,12 +232,12 @@ const EmitterMixin = {
 	/**
 	/**
 	 * Fires an event, executing all callbacks registered for it.
 	 * Fires an event, executing all callbacks registered for it.
 	 *
 	 *
-	 * The first parameter passed to callbacks is an {@link EventInfo} object, followed by the optional `args` provided in
-	 * the `fire()` method call.
+	 * The first parameter passed to callbacks is an {@link module:utils/eventinfo~EventInfo} object,
+	 * followed by the optional `args` provided in the `fire()` method call.
 	 *
 	 *
-	 * @param {String|utils.EventInfo} eventOrInfo The name of the event or `EventInfo` object if event is delegated.
+	 * @param {String|module:utils/eventinfo~EventInfo} eventOrInfo The name of the event or `EventInfo` object if event is delegated.
 	 * @param {...*} [args] Additional arguments to be passed to the callbacks.
 	 * @param {...*} [args] Additional arguments to be passed to the callbacks.
-	 * @method utils.EmitterMixin#fire
+	 * @method #fire
 	 */
 	 */
 	fire( eventOrInfo, ...args ) {
 	fire( eventOrInfo, ...args ) {
 		const eventInfo = eventOrInfo instanceof EventInfo ? eventOrInfo : new EventInfo( this, eventOrInfo );
 		const eventInfo = eventOrInfo instanceof EventInfo ? eventOrInfo : new EventInfo( this, eventOrInfo );
@@ -289,7 +290,7 @@ const EmitterMixin = {
 	},
 	},
 
 
 	/**
 	/**
-	 * Delegates selected events to another {@link utils.Emitter}. For instance:
+	 * Delegates selected events to another {@link module:utils/emittermixin~Emitter}. For instance:
 	 *
 	 *
 	 *		emitterA.delegate( 'eventX' ).to( emitterB );
 	 *		emitterA.delegate( 'eventX' ).to( emitterB );
 	 *		emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );
 	 *		emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );
@@ -302,17 +303,17 @@ const EmitterMixin = {
 	 *
 	 *
 	 *		emitterA.fire( 'eventY', data );
 	 *		emitterA.fire( 'eventY', data );
 	 *
 	 *
-	 * @method utils.EmitterMixin#delegate
+	 * @method #delegate
 	 * @param {...String} events Event names that will be delegated to another emitter.
 	 * @param {...String} events Event names that will be delegated to another emitter.
-	 * @returns {utils.EmitterMixin.delegate#to}
+	 * @returns {module:utils/emittermixin~EmitterMixin.delegate#to}
 	 */
 	 */
 	delegate( ...events ) {
 	delegate( ...events ) {
 		return {
 		return {
 			/**
 			/**
-			 * Selects destination for {@link utils.EmitterMixin#delegate} events.
+			 * Selects destination for {@link module:utils/emittermixin~EmitterMixin#delegate} events.
 			 *
 			 *
-			 * @method utils.EmitterMixin.delegate#to
-			 * @param {utils.Emitter} emitter An `EmitterMixin` instance which is the destination for delegated events.
+			 * @method module:utils/emittermixin~EmitterMixin.delegate#to
+			 * @param {module:utils/emittermixin~Emitter} emitter An `EmitterMixin` instance which is the destination for delegated events.
 			 */
 			 */
 			to: ( emitter ) => {
 			to: ( emitter ) => {
 				if ( !this._delegations ) {
 				if ( !this._delegations ) {
@@ -340,9 +341,9 @@ const EmitterMixin = {
 	 * * To stop delegating a specific event to a specific emitter.
 	 * * To stop delegating a specific event to a specific emitter.
 	 *
 	 *
 	 * @param {String} [event] The name of the event to stop delegating. If omitted, stops it all delegations.
 	 * @param {String} [event] The name of the event to stop delegating. If omitted, stops it all delegations.
-	 * @param {utils.Emitter} [emitter] (requires `event`) The object to stop delegating a particular event to. If omitted,
-	 * stops delegation of `event` to all emitters.
-	 * @method utils.EmitterMixin#stopDelegating
+	 * @param {module:utils/emittermixin~Emitter} [emitter] (requires `event`) The object to stop delegating a particular event to.
+	 * If omitted, stops delegation of `event` to all emitters.
+	 * @method #stopDelegating
 	 */
 	 */
 	stopDelegating( event, emitter ) {
 	stopDelegating( event, emitter ) {
 		if ( !this._delegations ) {
 		if ( !this._delegations ) {
@@ -498,7 +499,7 @@ function getCallbacksForEvent( source, eventName ) {
 }
 }
 
 
 /**
 /**
- * Interface representing classes which mix in {@link utils.EmitterMixin}.
+ * Interface representing classes which mix in {@link module:utils/emittermixin~EmitterMixin}.
  *
  *
- * @interface utils.Emitter
+ * @interface Emitter
  */
  */

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

@@ -30,7 +30,7 @@ export default class EventInfo {
 		this.name = name;
 		this.name = name;
 
 
 		/**
 		/**
-		 * Path this event has followed. See {@link utils.EmitterMixin#delegate}.
+		 * Path this event has followed. See {@link module:utils/emittermixin~EmitterMixin#delegate}.
 		 *
 		 *
 		 * @member #path
 		 * @member #path
 		 */
 		 */

+ 10 - 10
packages/ckeditor5-utils/src/focustracker.js

@@ -17,15 +17,15 @@ import mix from './mix.js';
 /**
 /**
  * Allows observing a group of `HTMLElement`s whether at least one of them is focused.
  * Allows observing a group of `HTMLElement`s whether at least one of them is focused.
  *
  *
- * Used by the {@link core.Editor} in order to track whether the focus is still within the application,
+ * Used by the {@link module:core/editor~Editor} in order to track whether the focus is still within the application,
  * or were used outside of its UI.
  * or were used outside of its UI.
  *
  *
  * **Note** `focus` and `blur` listeners use event capturing, so it is only needed to register wrapper `HTMLElement`
  * **Note** `focus` and `blur` listeners use event capturing, so it is only needed to register wrapper `HTMLElement`
  * 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"`).
  *
  *
- * @mixes utils.DOMEmitterMixin
- * @mixes utils.ObservableMixin
+ * @mixes module:utils/emittermixin/~DOMEmitterMixin
+ * @mixes module:utils/observablemixin/~ObservableMixin
  */
  */
 export default class FocusTracker {
 export default class FocusTracker {
 	constructor() {
 	constructor() {
@@ -34,7 +34,7 @@ export default class FocusTracker {
 		 *
 		 *
 		 * @readonly
 		 * @readonly
 		 * @observable
 		 * @observable
-		 * @member {Boolean} utils.FocusTracker#isFocused
+		 * @member {Boolean} #isFocused
 		 */
 		 */
 		this.set( 'isFocused', false );
 		this.set( 'isFocused', false );
 
 
@@ -42,7 +42,7 @@ export default class FocusTracker {
 		 * List of registered elements.
 		 * List of registered elements.
 		 *
 		 *
 		 * @private
 		 * @private
-		 * @member {Set<HTMLElement>} utils.FocusTracker#_elements
+		 * @member {Set<HTMLElement>} #_elements
 		 */
 		 */
 		this._elements = new Set();
 		this._elements = new Set();
 
 
@@ -50,7 +50,7 @@ export default class FocusTracker {
 		 * Event loop timeout.
 		 * Event loop timeout.
 		 *
 		 *
 		 * @private
 		 * @private
-		 * @member {Number} utils.FocusTracker#_nextEventLoopTimeout
+		 * @member {Number} #_nextEventLoopTimeout
 		 */
 		 */
 		this._nextEventLoopTimeout = null;
 		this._nextEventLoopTimeout = null;
 
 
@@ -58,7 +58,7 @@ export default class FocusTracker {
 		 * Currently focused element.
 		 * Currently focused element.
 		 *
 		 *
 		 * @private
 		 * @private
-		 * @member {HTMLElement} utils.FocusTracker#_focusedElement
+		 * @member {HTMLElement} #_focusedElement
 		 */
 		 */
 		this._focusedElement = null;
 		this._focusedElement = null;
 	}
 	}
@@ -95,7 +95,7 @@ export default class FocusTracker {
 	}
 	}
 
 
 	/**
 	/**
-	 * Stores currently focused element and set {utils.FocusTracker#isFocused} as `true`.
+	 * Stores currently focused element and set {#isFocused} as `true`.
 	 *
 	 *
 	 * @private
 	 * @private
 	 * @param {HTMLElement} element Element which has been focused.
 	 * @param {HTMLElement} element Element which has been focused.
@@ -108,11 +108,11 @@ export default class FocusTracker {
 	}
 	}
 
 
 	/**
 	/**
-	 * Clears currently focused element and set {utils.FocusTracker#isFocused} as `false`.
+	 * Clears currently focused element and set {#isFocused} as `false`.
 	 * This method uses `setTimeout` to change order of fires `blur` and `focus` events.
 	 * This method uses `setTimeout` to change order of fires `blur` and `focus` events.
 	 *
 	 *
 	 * @private
 	 * @private
-	 * @fires utils.FocusTracker#blur
+	 * @fires blur
 	 */
 	 */
 	_blur() {
 	_blur() {
 		this._nextEventLoopTimeout = setTimeout( () => {
 		this._nextEventLoopTimeout = setTimeout( () => {

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

@@ -10,7 +10,6 @@
 /**
 /**
  * Checks if value implements iterator interface.
  * Checks if value implements iterator interface.
  *
  *
- * @memberOf utils
  * @param {*} value The value to check.
  * @param {*} value The value to check.
  * @returns {Boolean} True if value implements iterator interface.
  * @returns {Boolean} True if value implements iterator interface.
  */
  */

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

@@ -12,7 +12,7 @@
  */
  */
 export default class Locale {
 export default class Locale {
 	/**
 	/**
-	 * Creates a new instance of the Locale class. {@link Foo#bar}
+	 * Creates a new instance of the Locale class. {@link ~Locale}
 	 *
 	 *
 	 * @param {String} [lang='en'] The language code in [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) format.
 	 * @param {String} [lang='en'] The language code in [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) format.
 	 */
 	 */
@@ -21,13 +21,13 @@ export default class Locale {
 		 * The language code in [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) format.
 		 * The language code in [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) format.
 		 *
 		 *
 		 * @readonly
 		 * @readonly
-		 * @member {String} utils.Locale#lang
+		 * @member {String} ~Locale#lang
 		 */
 		 */
 		this.lang = lang || 'en';
 		this.lang = lang || 'en';
 
 
 		/**
 		/**
 		 * Translates the given string to the {@link #lang}. This method is also availble in {@link Editor#t} and
 		 * Translates the given string to the {@link #lang}. This method is also availble in {@link Editor#t} and
-		 * {@link ui.View#t}.
+		 * {@link module:ui/view~View#t}.
 		 *
 		 *
 		 * The strings may contain placeholders (`%<index>`) for values which are passed as the second argument.
 		 * The strings may contain placeholders (`%<index>`) for values which are passed as the second argument.
 		 * `<index>` is the index in the `values` array.
 		 * `<index>` is the index in the `values` array.
@@ -40,7 +40,7 @@ export default class Locale {
 		 *		const t = this.t;
 		 *		const t = this.t;
 		 *		t( 'Label' );
 		 *		t( 'Label' );
 		 *
 		 *
-		 * @method utils.Locale#t
+		 * @method module:utils/locale~Locale#t
 		 * @param {String} str The string to translate.
 		 * @param {String} str The string to translate.
 		 * @param {String[]} values Values that should be used to interpolate the string.
 		 * @param {String[]} values Values that should be used to interpolate the string.
 		 */
 		 */

+ 5 - 7
packages/ckeditor5-utils/src/log.js

@@ -37,21 +37,19 @@
  * log a warning.
  * log a warning.
  * * Whenever an incorrect situation occurs, but the app may continue working (although perhaps incorrectly),
  * * Whenever an incorrect situation occurs, but the app may continue working (although perhaps incorrectly),
  * log an error.
  * log an error.
- * * Whenever it's really bad and it does not make sense to continue working, throw a {@link utils.CKEditorError}.
- *
- * @namespace utils.log
+ * * Whenever it's really bad and it does not make sense to continue working, throw a {@link module:utils/ckeditorerror~CKEditorError}.
  */
  */
 const log = {
 const log = {
 	/**
 	/**
 	 * Logs an error to the console.
 	 * Logs an error to the console.
 	 *
 	 *
-	 * 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
 	 * and a link to this error documentation will be logged to the console.
 	 * and a link to this error documentation will be logged to the console.
 	 * @param {Object} [data] Additional data describing the error.
 	 * @param {Object} [data] Additional data describing the error.
-	 * @method utils.log.error
+	 * @method #error
 	 */
 	 */
 	error( message, data ) {
 	error( message, data ) {
 		console.error( message, data );
 		console.error( message, data );
@@ -60,13 +58,13 @@ const log = {
 	/**
 	/**
 	 * Logs a warning to the console.
 	 * Logs a warning to the console.
 	 *
 	 *
-	 * 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 warning message in a `warning-name: Warning message.` format.
 	 * @param {String} message The warning message in a `warning-name: Warning message.` format.
 	 * During the minification process the "Warning message" part will be removed to limit the code size
 	 * During the minification process the "Warning message" part will be removed to limit the code size
 	 * and a link to this error documentation will be logged to the console.
 	 * and a link to this error documentation will be logged to the console.
 	 * @param {Object} [data] Additional data describing the warning.
 	 * @param {Object} [data] Additional data describing the warning.
-	 * @method utils.log.warn
+	 * @method #warn
 	 */
 	 */
 	warn( message, data ) {
 	warn( message, data ) {
 		console.warn( message, data );
 		console.warn( message, data );

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

@@ -10,7 +10,6 @@
 /**
 /**
  * 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.
  *
  *
- * @memberOf utils
  * @returns {Boolean} `true` if given maps are equal, `false` otherwise.
  * @returns {Boolean} `true` if given maps are equal, `false` otherwise.
  */
  */
 export default function mapsEqual( mapA, mapB ) {
 export default function mapsEqual( mapA, mapB ) {

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

@@ -27,7 +27,6 @@
  *
  *
  * Note: Properties which already exist in the base class will not be overriden.
  * Note: Properties which already exist in the base class will not be overriden.
  *
  *
- * @memberOf utils
  * @param {Function} [baseClass] Class which prototype will be extended.
  * @param {Function} [baseClass] Class which prototype will be extended.
  * @param {Object} [...mixins] Objects from which to get properties.
  * @param {Object} [...mixins] Objects from which to get properties.
  */
  */

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

@@ -10,7 +10,6 @@
 /**
 /**
  * Returns `nth` (starts from `0` of course) item of an `iterable`.
  * Returns `nth` (starts from `0` of course) item of an `iterable`.
  *
  *
- * @memberOf utils
  * @param {Number} index
  * @param {Number} index
  * @param {Iterable.<*>} iterable
  * @param {Iterable.<*>} iterable
  * @returns {*}
  * @returns {*}

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

@@ -13,7 +13,6 @@
  *		const map = objectToMap( { 'foo': 1, 'bar': 2 } );
  *		const map = objectToMap( { 'foo': 1, 'bar': 2 } );
  *		map.get( 'foo' ); // 1
  *		map.get( 'foo' ); // 1
  *
  *
- * @memberOf utils
  * @param {Object} obj Object to transform.
  * @param {Object} obj Object to transform.
  * @returns {Map} Map created from object.
  * @returns {Map} Map created from object.
  */
  */

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

@@ -4,7 +4,7 @@
  */
  */
 
 
 /**
 /**
- * @module module:observablemixin
+ * @module utils/observablemixin
  */
  */
 
 
 import EmitterMixin from './emittermixin.js';
 import EmitterMixin from './emittermixin.js';
@@ -22,7 +22,7 @@ const boundAttributesSymbol = Symbol( 'boundAttributes' );
  *
  *
  * @mixin ObservableMixin
  * @mixin ObservableMixin
  * @mixes module:utils/emittermixin~EmitterMixin
  * @mixes module:utils/emittermixin~EmitterMixin
- * @implements utils.Observable
+ * @implements module:utils/observablemixin~Observable
  */
  */
 const ObservableMixin = {
 const ObservableMixin = {
 	/**
 	/**
@@ -57,7 +57,7 @@ const ObservableMixin = {
 			/**
 			/**
 			 * Cannot override an existing property.
 			 * Cannot override an existing property.
 			 *
 			 *
-			 * This error is thrown when trying to {@link utils.Observable#set set} an attribute with
+			 * This error is thrown when trying to {@link ~Observable#set set} an attribute with
 			 * a name of an already existing property. For example:
 			 * a name of an already existing property. For example:
 			 *
 			 *
 			 *		let observable = new Model();
 			 *		let observable = new Model();
@@ -96,14 +96,14 @@ const ObservableMixin = {
 	},
 	},
 
 
 	/**
 	/**
-	 * Binds observable attributes to another objects implementing {@link ObservableMixin}
+	 * Binds observable attributes to another objects implementing {@link ~ObservableMixin}
 	 * interface (like {@link ui.Model}).
 	 * interface (like {@link ui.Model}).
 	 *
 	 *
 	 * Once bound, the observable will immediately share the current state of attributes
 	 * Once bound, the observable will immediately share the current state of attributes
 	 * 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 #unbind}.
+	 * **Note**: To release the binding use {@link module:utils/observablemixin~ObservableMixin#unbind}.
 	 *
 	 *
 	 *		A.bind( 'a' ).to( B );
 	 *		A.bind( 'a' ).to( B );
 	 *		A.bind( 'a' ).to( B, 'b' );
 	 *		A.bind( 'a' ).to( B, 'b' );
@@ -112,7 +112,7 @@ const ObservableMixin = {
 	 *
 	 *
 	 * @method #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 {BindChain}
 	 */
 	 */
 	bind( ...bindAttrs ) {
 	bind( ...bindAttrs ) {
 		if ( !bindAttrs.length || !isStringArray( bindAttrs ) ) {
 		if ( !bindAttrs.length || !isStringArray( bindAttrs ) ) {
@@ -151,7 +151,7 @@ const ObservableMixin = {
 		const bindings = new Map();
 		const bindings = new Map();
 
 
 		/**
 		/**
-		 * @typedef utils.Binding
+		 * @typedef Binding
 		 * @type Object
 		 * @type Object
 		 * @property {Array} attr Attribute which is bound.
 		 * @property {Array} attr Attribute which is bound.
 		 * @property {Array} to Array of observable–attribute components of the binding (`{ observable: ..., attr: .. }`).
 		 * @property {Array} to Array of observable–attribute components of the binding (`{ observable: ..., attr: .. }`).
@@ -165,14 +165,14 @@ const ObservableMixin = {
 		} );
 		} );
 
 
 		/**
 		/**
-		 * @typedef utils.BindChain
+		 * @typedef BindChain
 		 * @type Object
 		 * @type Object
-		 * @property {Function} to See {@link utils.ObservableMixin#_bindTo}.
+		 * @property {Function} to See {@link ~ObservableMixin#_bindTo}.
 		 * @property {Observable} _observable The observable which initializes the binding.
 		 * @property {Observable} _observable The observable which initializes the binding.
 		 * @property {Array} _bindAttrs Array of `_observable` attributes to be bound.
 		 * @property {Array} _bindAttrs Array of `_observable` attributes to be bound.
 		 * @property {Array} _to Array of `to()` observable–attributes (`{ observable: toObservable, attrs: ...toAttrs }`).
 		 * @property {Array} _to Array of `to()` observable–attributes (`{ observable: toObservable, attrs: ...toAttrs }`).
 		 * @property {Map} _bindings Stores bindings to be kept in
 		 * @property {Map} _bindings Stores bindings to be kept in
-		 *  {@link utils.ObservableMixin#_boundAttributes}/{@link utils.ObservableMixin#_boundObservables}
+		 *  {@link ~ObservableMixin#_boundAttributes}/{@link ~ObservableMixin#_boundObservables}
 		 * initiated in this binding chain.
 		 * initiated in this binding chain.
 		 */
 		 */
 		return {
 		return {
@@ -186,12 +186,12 @@ const ObservableMixin = {
 	},
 	},
 
 
 	/**
 	/**
-	 * Removes the binding created with {@link utils.ObservableMixin#bind}.
+	 * Removes the binding created with {@link ~ObservableMixin#bind}.
 	 *
 	 *
 	 *		A.unbind( 'a' );
 	 *		A.unbind( 'a' );
 	 *		A.unbind();
 	 *		A.unbind();
 	 *
 	 *
-	 * @method utils.ObservableMixin#unbind
+	 * @method ~ObservableMixin#unbind
 	 * @param {...String} [unbindAttrs] Observable attributes to be unbound. All the bindings will
 	 * @param {...String} [unbindAttrs] Observable attributes to be unbound. All the bindings will
 	 * be released if no attributes provided.
 	 * be released if no attributes provided.
 	 */
 	 */
@@ -255,7 +255,7 @@ export default ObservableMixin;
 // Init symbol properties needed to for the observable mechanism to work.
 // Init symbol properties needed to for the observable mechanism to work.
 //
 //
 // @private
 // @private
-// @param {ObservableMixin} observable
+// @param {module:utils/observablemixin~ObservableMixin} observable
 function initObservable( observable ) {
 function initObservable( observable ) {
 	// Do nothing if already inited.
 	// Do nothing if already inited.
 	if ( attributesSymbol in observable ) {
 	if ( attributesSymbol in observable ) {
@@ -271,9 +271,9 @@ function initObservable( observable ) {
 	} );
 	} );
 
 
 	// Map containing bindings to external observables. It shares the binding objects
 	// Map containing bindings to external observables. It shares the binding objects
-	// (`{ observable: A, attr: 'a', to: ... }`) with {@link utils.ObservableMixin#_boundAttributes} and
+	// (`{ observable: A, attr: 'a', to: ... }`) with {@link module:utils/observablemixin~ObservableMixin#_boundAttributes} and
 	// it is used to observe external observables to update own attributes accordingly.
 	// it is used to observe external observables to update own attributes accordingly.
-	// See {@link utils.ObservableMixin#bind}.
+	// See {@link module:utils/observablemixin~ObservableMixin#bind}.
 	//
 	//
 	//		A.bind( 'a', 'b', 'c' ).to( B, 'x', 'y', 'x' );
 	//		A.bind( 'a', 'b', 'c' ).to( B, 'x', 'y', 'x' );
 	//		console.log( A._boundObservables );
 	//		console.log( A._boundObservables );
@@ -352,7 +352,7 @@ function initObservable( observable ) {
 	} );
 	} );
 }
 }
 
 
-// A chaining for {@link utils.ObservableMixin#bind} providing `.to()` interface.
+// A chaining for {@link module:utils/observablemixin~ObservableMixin#bind} providing `.to()` interface.
 //
 //
 // @private
 // @private
 // @param {...[Observable|String|Function]} args Arguments of the `.to( args )` binding.
 // @param {...[Observable|String|Function]} args Arguments of the `.to( args )` binding.
@@ -477,7 +477,7 @@ function parseBindToArgs( ...args ) {
 	return parsed;
 	return parsed;
 }
 }
 
 
-// Synchronizes {@link Observable#_boundObservables} with {@link Binding}.
+// Synchronizes {@link module:utils/observablemixin#_boundObservables} with {@link Binding}.
 //
 //
 // @private
 // @private
 // @param {Binding} binding A binding to store in {@link Observable#_boundObservables}.
 // @param {Binding} binding A binding to store in {@link Observable#_boundObservables}.
@@ -618,14 +618,14 @@ extend( ObservableMixin, EmitterMixin );
 /**
 /**
  * Fired when an attribute changed value.
  * Fired when an attribute changed value.
  *
  *
- * @event utils.ObservableMixin#change:{attribute}
+ * @event module:utils/observablemixin~ObservableMixin#change:{attribute}
  * @param {String} name The attribute name.
  * @param {String} name The attribute name.
  * @param {*} value The new attribute value.
  * @param {*} value The new attribute value.
  * @param {*} oldValue The previous attribute value.
  * @param {*} oldValue The previous attribute value.
  */
  */
 
 
 /**
 /**
- * Interface representing classes which mix in {@link utils.ObservableMixin}.
+ * Interface representing classes which mix in {@link module:utils/observablemixin~ObservableMixin}.
  *
  *
- * @interface utils.Observable
+ * @interface Observable
  */
  */

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

@@ -4,13 +4,13 @@
  */
  */
 
 
 /**
 /**
- * @module utils/priorites
+ * @module utils/priorities
  */
  */
 
 
 /**
 /**
  * String representing a priority value.
  * String representing a priority value.
  *
  *
- * @typedef {'highest'|'high'|'normal'|'low'|'lowest'} utils.PriorityString
+ * @typedef {'highest'|'high'|'normal'|'low'|'lowest'} module:utils/priorities~PriorityString
  */
  */
 
 
 /**
 /**
@@ -20,7 +20,7 @@ const priorities = {
 	/**
 	/**
 	 * Converts a string with priority name to it's numeric value. If `Number` is given, it just returns it.
 	 * Converts a string with priority name to it's numeric value. If `Number` is given, it just returns it.
 	 *
 	 *
-	 * @param {utils.PriorityString|Number} priority Priority to convert.
+	 * @param {module:utils/priorities~PriorityString|Number} priority Priority to convert.
 	 * @returns {Number} Converted priority.
 	 * @returns {Number} Converted priority.
 	 */
 	 */
 	get( priority ) {
 	get( priority ) {

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

@@ -11,7 +11,7 @@
  * 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
+ * @method uid
  * @returns {Number} A number representing the id.
  * @returns {Number} A number representing the id.
  */
  */
 export default ( () => {
 export default ( () => {