@ckeditor/ckeditor5-engine 35.4.0 → 36.0.1

package/src/model/element.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 /**
@@ -16,8 +16,6 @@ import { isIterable } from '@ckeditor/ckeditor5-utils';
  * {@link module:engine/model/element~Element#getChildren child nodes}.
  *
  * **Important**: see {@link module:engine/model/node~Node} to read about restrictions using `Element` and `Node` API.
- *
- * @extends module:engine/model/node~Node
  */
 export default class Element extends Node {
     /**
@@ -26,72 +24,48 @@ export default class Element extends Node {
      * **Note:** Constructor of this class shouldn't be used directly in the code.
      * Use the {@link module:engine/model/writer~Writer#createElement} method instead.
      *
-     * @protected
-     * @param {String} name Element's name.
-     * @param {Object} [attrs] Element's attributes. See {@link module:utils/tomap~toMap} for a list of accepted values.
-     * @param {module:engine/model/node~Node|Iterable.<module:engine/model/node~Node>} [children]
-     * One or more nodes to be inserted as children of created element.
+     * @internal
+     * @param name Element's name.
+     * @param attrs Element's attributes. See {@link module:utils/tomap~toMap} for a list of accepted values.
+     * @param children One or more nodes to be inserted as children of created element.
      */
     constructor(name, attrs, children) {
         super(attrs);
-        /**
-         * Element name.
-         *
-         * @readonly
-         * @member {String} module:engine/model/element~Element#name
-         */
-        this.name = name;
         /**
          * List of children nodes.
-         *
-         * @private
-         * @member {module:engine/model/nodelist~NodeList} module:engine/model/element~Element#_children
          */
         this._children = new NodeList();
+        this.name = name;
         if (children) {
             this._insertChild(0, children);
         }
     }
     /**
      * Number of this element's children.
-     *
-     * @readonly
-     * @type {Number}
      */
     get childCount() {
         return this._children.length;
     }
     /**
      * Sum of {@link module:engine/model/node~Node#offsetSize offset sizes} of all of this element's children.
-     *
-     * @readonly
-     * @type {Number}
      */
     get maxOffset() {
         return this._children.maxOffset;
     }
     /**
      * Is `true` if there are no nodes inside this element, `false` otherwise.
-     *
-     * @readonly
-     * @type {Boolean}
      */
     get isEmpty() {
         return this.childCount === 0;
     }
     /**
      * Gets the child at the given index.
-     *
-     * @param {Number} index Index of child.
-     * @returns {module:engine/model/node~Node|null} Child node.
      */
     getChild(index) {
         return this._children.getNode(index);
     }
     /**
      * Returns an iterator that iterates over all of this element's children.
-     *
-     * @returns {Iterable.<module:engine/model/node~Node>}
      */
     getChildren() {
         return this._children[Symbol.iterator]();
@@ -99,8 +73,8 @@ export default class Element extends Node {
     /**
      * Returns an index of the given child node. Returns `null` if given node is not a child of this element.
      *
-     * @param {module:engine/model/node~Node} node Child node to look for.
-     * @returns {Number|null} Child node's index in this element.
+     * @param node Child node to look for.
+     * @returns Child node's index in this element.
      */
     getChildIndex(node) {
         return this._children.getNodeIndex(node);
@@ -110,8 +84,8 @@ export default class Element extends Node {
      * {@link module:engine/model/node~Node#offsetSize offset sizes} of all node's siblings that are before it. Returns `null` if
      * given node is not a child of this element.
      *
-     * @param {module:engine/model/node~Node} node Child node to look for.
-     * @returns {Number|null} Child node's starting offset.
+     * @param node Child node to look for.
+     * @returns Child node's starting offset.
      */
     getChildStartOffset(node) {
         return this._children.getNodeStartOffset(node);
@@ -120,18 +94,17 @@ export default class Element extends Node {
      * Returns index of a node that occupies given offset. If given offset is too low, returns `0`. If given offset is
      * too high, returns {@link module:engine/model/element~Element#getChildIndex index after last child}.
      *
-     *		const textNode = new Text( 'foo' );
-     *		const pElement = new Element( 'p' );
-     *		const divElement = new Element( [ textNode, pElement ] );
-     *		divElement.offsetToIndex( -1 ); // Returns 0, because offset is too low.
-     *		divElement.offsetToIndex( 0 ); // Returns 0, because offset 0 is taken by `textNode` which is at index 0.
-     *		divElement.offsetToIndex( 1 ); // Returns 0, because `textNode` has `offsetSize` equal to 3, so it occupies offset 1 too.
-     *		divElement.offsetToIndex( 2 ); // Returns 0.
-     *		divElement.offsetToIndex( 3 ); // Returns 1.
-     *		divElement.offsetToIndex( 4 ); // Returns 2. There are no nodes at offset 4, so last available index is returned.
-     *
-     * @param {Number} offset Offset to look for.
-     * @returns {Number}
+     * ```ts
+     * const textNode = new Text( 'foo' );
+     * const pElement = new Element( 'p' );
+     * const divElement = new Element( [ textNode, pElement ] );
+     * divElement.offsetToIndex( -1 ); // Returns 0, because offset is too low.
+     * divElement.offsetToIndex( 0 ); // Returns 0, because offset 0 is taken by `textNode` which is at index 0.
+     * divElement.offsetToIndex( 1 ); // Returns 0, because `textNode` has `offsetSize` equal to 3, so it occupies offset 1 too.
+     * divElement.offsetToIndex( 2 ); // Returns 0.
+     * divElement.offsetToIndex( 3 ); // Returns 1.
+     * divElement.offsetToIndex( 4 ); // Returns 2. There are no nodes at offset 4, so last available index is returned.
+     * ```
      */
     offsetToIndex(offset) {
         return this._children.offsetToIndex(offset);
@@ -139,13 +112,14 @@ export default class Element extends Node {
     /**
      * Returns a descendant node by its path relative to this element.
      *
-     *		// <this>a<b>c</b></this>
-     *		this.getNodeByPath( [ 0 ] );     // -> "a"
-     *		this.getNodeByPath( [ 1 ] );     // -> <b>
-     *		this.getNodeByPath( [ 1, 0 ] );  // -> "c"
+     * ```ts
+     * // <this>a<b>c</b></this>
+     * this.getNodeByPath( [ 0 ] );     // -> "a"
+     * this.getNodeByPath( [ 1 ] );     // -> <b>
+     * this.getNodeByPath( [ 1, 0 ] );  // -> "c"
+     * ```
      *
-     * @param {Array.<Number>} relativePath Path of the node to find, relative to this element.
-     * @returns {module:engine/model/node~Node}
+     * @param relativePath Path of the node to find, relative to this element.
      */
     getNodeByPath(relativePath) {
         // eslint-disable-next-line @typescript-eslint/no-this-alias, consistent-this
@@ -158,10 +132,9 @@ export default class Element extends Node {
     /**
      * Returns the parent element of the given name. Returns null if the element is not inside the desired parent.
      *
-     * @param {String} parentName The name of the parent element to find.
-     * @param {Object} [options] Options object.
-     * @param {Boolean} [options.includeSelf=false] When set to `true` this node will be also included while searching.
-     * @returns {module:engine/model/element~Element|null}
+     * @param parentName The name of the parent element to find.
+     * @param options Options object.
+     * @param options.includeSelf When set to `true` this node will be also included while searching.
      */
     findAncestor(parentName, options = {}) {
         let parent = options.includeSelf ? this : this.parent;
@@ -176,7 +149,7 @@ export default class Element extends Node {
     /**
      * Converts `Element` instance to plain object and returns it. Takes care of converting all of this element's children.
      *
-     * @returns {Object} `Element` instance converted to plain object.
+     * @returns `Element` instance converted to plain object.
      */
     toJSON() {
         const json = super.toJSON();
@@ -194,8 +167,7 @@ export default class Element extends Node {
      * If clone is deep, the original element's children are also cloned. If not, then empty element is returned.
      *
      * @internal
-     * @protected
-     * @param {Boolean} [deep=false] If set to `true` clones element and all its children recursively. When set to `false`,
+     * @param deep If set to `true` clones element and all its children recursively. When set to `false`,
      * element will be cloned without any child.
      */
     _clone(deep = false) {
@@ -207,8 +179,7 @@ export default class Element extends Node {
      *
      * @see module:engine/model/writer~Writer#append
      * @internal
-     * @protected
-     * @param {String|module:engine/model/item~Item|Iterable.<String|module:engine/model/item~Item>} nodes Nodes to be inserted.
+     * @param nodes Nodes to be inserted.
      */
     _appendChild(nodes) {
         this._insertChild(this.childCount, nodes);
@@ -219,9 +190,8 @@ export default class Element extends Node {
      *
      * @see module:engine/model/writer~Writer#insert
      * @internal
-     * @protected
-     * @param {Number} index Index at which nodes should be inserted.
-     * @param {String|module:engine/model/item~Item|Iterable.<String|module:engine/model/item~Item>} items Items to be inserted.
+     * @param index Index at which nodes should be inserted.
+     * @param items Items to be inserted.
      */
     _insertChild(index, items) {
         const nodes = normalize(items);
@@ -239,10 +209,10 @@ export default class Element extends Node {
      * {@link module:engine/model/node~Node#parent parent} of these nodes to `null`.
      *
      * @see module:engine/model/writer~Writer#remove
-     * @protected
-     * @param {Number} index Index of the first node to remove.
-     * @param {Number} [howMany=1] Number of nodes to remove.
-     * @returns {Array.<module:engine/model/node~Node>} Array containing removed nodes.
+     * @internal
+     * @param index Index of the first node to remove.
+     * @param howMany Number of nodes to remove.
+     * @returns Array containing removed nodes.
      */
     _removeChildren(index, howMany = 1) {
         const nodes = this._children._removeNodes(index, howMany);
@@ -255,8 +225,8 @@ export default class Element extends Node {
      * Creates an `Element` instance from given plain object (i.e. parsed JSON string).
      * Converts `Element` children to proper nodes.
      *
-     * @param {Object} json Plain object to be converted to `Element`.
-     * @returns {module:engine/model/element~Element} `Element` instance created using given plain object.
+     * @param json Plain object to be converted to `Element`.
+     * @returns `Element` instance created using given plain object.
      */
     static fromJSON(json) {
         let children;
@@ -276,30 +246,8 @@ export default class Element extends Node {
         return new Element(json.name, json.attributes, children);
     }
 }
-/**
- * Checks whether this object is of the given.
- *
- *		element.is( 'element' ); // -> true
- *		element.is( 'node' ); // -> true
- *		element.is( 'model:element' ); // -> true
- *		element.is( 'model:node' ); // -> true
- *
- *		element.is( 'view:element' ); // -> false
- *		element.is( 'documentSelection' ); // -> false
- *
- * Assuming that the object being checked is an element, you can also check its
- * {@link module:engine/model/element~Element#name name}:
- *
- *		element.is( 'element', 'imageBlock' ); // -> true if this is an <imageBlock> element
- *		element.is( 'element', 'imageBlock' ); // -> same as above
- *		text.is( 'element', 'imageBlock' ); -> false
- *
- * {@link module:engine/model/node~Node#is Check the entire list of model objects} which implement the `is()` method.
- *
- * @param {String} type Type to check.
- * @param {String} [name] Element name.
- * @returns {Boolean}
- */
+// The magic of type inference using `is` method is centralized in `TypeCheckable` class.
+// Proper overload would interfere with that.
 Element.prototype.is = function (type, name) {
     if (!name) {
         return type === 'element' || type === 'model:element' ||
@@ -308,10 +256,9 @@ Element.prototype.is = function (type, name) {
     }
     return name === this.name && (type === 'element' || type === 'model:element');
 };
-// Converts strings to Text and non-iterables to arrays.
-//
-// @param {String|module:engine/model/item~Item|Iterable.<String|module:engine/model/item~Item>}
-// @returns {Iterable.<module:engine/model/node~Node>}
+/**
+ * Converts strings to Text and non-iterables to arrays.
+ */
 function normalize(nodes) {
     // Separate condition because string is iterable.
     if (typeof nodes == 'string') {

package/src/model/history.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 import { CKEditorError } from '@ckeditor/ckeditor5-utils';
@@ -10,16 +10,9 @@ import { CKEditorError } from '@ckeditor/ckeditor5-utils';
  * `History` keeps the track of all the operations applied to the {@link module:engine/model/document~Document document}.
  */
 export default class History {
-    /**
-     * Creates an empty History instance.
-     */
     constructor() {
         /**
          * Operations added to the history.
-         *
-         * @private
-         * @readonly
-         * @type {Array.<module:engine/model/operation/operation~Operation>}
          */
         this._operations = [];
         /**
@@ -28,30 +21,18 @@ export default class History {
          *
          * Keys of the map are "undoing operations", that is operations that undone some other operations. For each key, the
          * value is an operation that has been undone by the "undoing operation".
-         *
-         * @private
-         * @member {Map} module:engine/model/history~History#_undoPairs
          */
         this._undoPairs = new Map();
         /**
          * Holds all undone operations.
-         *
-         * @private
-         * @type {Set.<module:engine/model/operation/operation~Operation>}
          */
         this._undoneOperations = new Set();
         /**
          * A map that allows retrieving the operations fast based on the given base version.
-         *
-         * @private
-         * @type Map.<Number,Number>
          */
         this._baseVersionToOperationIndex = new Map();
         /**
          * The history version.
-         *
-         * @private
-         * @type {Number}
          */
         this._version = 0;
         /**
@@ -59,9 +40,6 @@ export default class History {
          *
          * Anytime the `history.version` is set to a version larger than `history.version + 1`,
          * a new <lastHistoryVersion, newHistoryVersion> entry is added to the map.
-         *
-         * @private
-         * @type Map.<number,number>
          */
         this._gaps = new Map();
     }
@@ -72,8 +50,6 @@ export default class History {
      * Setting the version manually should be done only in rare circumstances when a gap is planned
      * between history versions. When doing so, a gap will be created and the history will accept adding
      * an operation with base version equal to the new history version.
-     *
-     * @type {Number}
      */
     get version() {
         return this._version;
@@ -88,9 +64,6 @@ export default class History {
     }
     /**
      * The last history operation.
-     *
-     * @readonly
-     * @type {module:engine/model/operation/operation~Operation|undefined}
      */
     get lastOperation() {
         return this._operations[this._operations.length - 1];
@@ -99,8 +72,6 @@ export default class History {
      * Adds an operation to the history and increments the history version.
      *
      * The operation's base version should be equal to the history version. Otherwise an error is thrown.
-     *
-     * @param {module:engine/model/operation/operation~Operation} operation Operation to add.
      */
     addOperation(operation) {
         if (operation.baseVersion !== this.version) {
@@ -108,7 +79,7 @@ export default class History {
              * Only operations with matching versions can be added to the history.
              *
              * @error model-document-history-addoperation-incorrect-version
-             * @param {Object} errorData The operation and the current document history version.
+             * @param errorData The operation and the current document history version.
              */
             throw new CKEditorError('model-document-history-addoperation-incorrect-version', this, {
                 operation,
@@ -124,9 +95,9 @@ export default class History {
      *
      * Note that there may be gaps in operations base versions.
      *
-     * @param {Number} [fromBaseVersion] Base version from which operations should be returned (inclusive).
-     * @param {Number} [toBaseVersion] Base version up to which operations should be returned (exclusive).
-     * @returns {Array.<module:engine/model/operation/operation~Operation>} History operations for the given range, in chronological order.
+     * @param fromBaseVersion Base version from which operations should be returned (inclusive).
+     * @param toBaseVersion Base version up to which operations should be returned (exclusive).
+     * @returns History operations for the given range, in chronological order.
      */
     getOperations(fromBaseVersion, toBaseVersion = this.version) {
         // When there is no operation in the history, return an empty array.
@@ -174,9 +145,8 @@ export default class History {
     /**
      * Returns operation from the history that bases on given `baseVersion`.
      *
-     * @param {Number} baseVersion Base version of the operation to get.
-     * @returns {module:engine/model/operation/operation~Operation|undefined} Operation with given base version or `undefined` if
-     * there is no such operation in history.
+     * @param baseVersion Base version of the operation to get.
+     * @returns Operation with given base version or `undefined` if there is no such operation in history.
      */
     getOperation(baseVersion) {
         const operationIndex = this._baseVersionToOperationIndex.get(baseVersion);
@@ -189,8 +159,8 @@ export default class History {
      * Marks in history that one operation is an operation that is undoing the other operation. By marking operation this way,
      * history is keeping more context information about operations, which helps in operational transformation.
      *
-     * @param {module:engine/model/operation/operation~Operation} undoneOperation Operation which is undone by `undoingOperation`.
-     * @param {module:engine/model/operation/operation~Operation} undoingOperation Operation which undoes `undoneOperation`.
+     * @param undoneOperation Operation which is undone by `undoingOperation`.
+     * @param undoingOperation Operation which undoes `undoneOperation`.
      */
     setOperationAsUndone(undoneOperation, undoingOperation) {
         this._undoPairs.set(undoingOperation, undoneOperation);
@@ -199,8 +169,8 @@ export default class History {
     /**
      * Checks whether given `operation` is undoing any other operation.
      *
-     * @param {module:engine/model/operation/operation~Operation} operation Operation to check.
-     * @returns {Boolean} `true` if given `operation` is undoing any other operation, `false` otherwise.
+     * @param operation Operation to check.
+     * @returns `true` if given `operation` is undoing any other operation, `false` otherwise.
      */
     isUndoingOperation(operation) {
         return this._undoPairs.has(operation);
@@ -208,8 +178,8 @@ export default class History {
     /**
      * Checks whether given `operation` has been undone by any other operation.
      *
-     * @param {module:engine/model/operation/operation~Operation} operation Operation to check.
-     * @returns {Boolean} `true` if given `operation` has been undone any other operation, `false` otherwise.
+     * @param operation Operation to check.
+     * @returns `true` if given `operation` has been undone any other operation, `false` otherwise.
      */
     isUndoneOperation(operation) {
         return this._undoneOperations.has(operation);
@@ -217,9 +187,8 @@ export default class History {
     /**
      * For given `undoingOperation`, returns the operation which has been undone by it.
      *
-     * @param {module:engine/model/operation/operation~Operation} undoingOperation
-     * @returns {module:engine/model/operation/operation~Operation|undefined} Operation that has been undone by given
-     * `undoingOperation` or `undefined` if given `undoingOperation` is not undoing any other operation.
+     * @returns Operation that has been undone by given `undoingOperation` or `undefined`
+     * if given `undoingOperation` is not undoing any other operation.
      */
     getUndoneOperation(undoingOperation) {
         return this._undoPairs.get(undoingOperation);

package/src/model/item.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 export {};

package/src/model/liveposition.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 /**
@@ -19,17 +19,12 @@ import { CKEditorError, EmitterMixin } from '@ckeditor/ckeditor5-utils';
  * **Note:** Be very careful when dealing with `LivePosition`. Each `LivePosition` instance bind events that might
  * have to be unbound.
  * Use {@link module:engine/model/liveposition~LivePosition#detach} whenever you don't need `LivePosition` anymore.
- *
- * @extends module:engine/model/position~Position
  */
 export default class LivePosition extends EmitterMixin(Position) {
     /**
      * Creates a live position.
      *
      * @see module:engine/model/position~Position
-     * @param {module:engine/model/rootelement~RootElement} root
-     * @param {Array.<Number>} path
-     * @param {module:engine/model/position~PositionStickiness} [stickiness]
      */
     constructor(root, path, stickiness = 'toNone') {
         super(root, path, stickiness);
@@ -53,48 +48,28 @@ export default class LivePosition extends EmitterMixin(Position) {
     }
     /**
      * Creates a {@link module:engine/model/position~Position position instance}, which is equal to this live position.
-     *
-     * @returns {module:engine/model/position~Position}
      */
     toPosition() {
         return new Position(this.root, this.path.slice(), this.stickiness);
     }
     /**
      * Creates a `LivePosition` instance that is equal to position.
-     *
-     * @param {module:engine/model/position~Position} position
-     * @param {module:engine/model/position~PositionStickiness} [stickiness]
-     * @returns {module:engine/model/liveposition~LivePosition}
      */
     static fromPosition(position, stickiness) {
         return new this(position.root, position.path.slice(), stickiness ? stickiness : position.stickiness);
     }
 }
-/**
- * Checks whether this object is of the given.
- *
- *		livePosition.is( 'position' ); // -> true
- *		livePosition.is( 'model:position' ); // -> true
- *		livePosition.is( 'liveposition' ); // -> true
- *		livePosition.is( 'model:livePosition' ); // -> true
- *
- *		livePosition.is( 'view:position' ); // -> false
- *		livePosition.is( 'documentSelection' ); // -> false
- *
- * {@link module:engine/model/node~Node#is Check the entire list of model objects} which implement the `is()` method.
- *
- * @param {String} type
- * @returns {Boolean}
- */
+// The magic of type inference using `is` method is centralized in `TypeCheckable` class.
+// Proper overload would interfere with that.
 LivePosition.prototype.is = function (type) {
     return type === 'livePosition' || type === 'model:livePosition' ||
         // From super.is(). This is highly utilised method and cannot call super. See ckeditor/ckeditor5#6529.
         type == 'position' || type === 'model:position';
 };
-// Binds this `LivePosition` to the {@link module:engine/model/document~Document document} that owns
-// this position's {@link module:engine/model/position~Position#root root}.
-//
-// @private
+/**
+ * Binds this `LivePosition` to the {@link module:engine/model/document~Document document} that owns
+ * this position's {@link module:engine/model/position~Position#root root}.
+ */
 function bindWithDocument() {
     this.listenTo(this.root.document.model, 'applyOperation', (event, args) => {
         const operation = args[0];
@@ -104,10 +79,9 @@ function bindWithDocument() {
         transform.call(this, operation);
     }, { priority: 'low' });
 }
-// Updates this position accordingly to the updates applied to the model. Bases on change events.
-//
-// @private
-// @param {module:engine/model/operation/operation~Operation} operation Executed operation.
+/**
+ * Updates this position accordingly to the updates applied to the model. Bases on change events.
+ */
 function transform(operation) {
     const result = this.getTransformedByOperation(operation);
     if (!this.isEqual(result)) {

package/src/model/liverange.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 /**
@@ -35,47 +35,28 @@ export default class LiveRange extends EmitterMixin(Range) {
     }
     /**
      * Creates a {@link module:engine/model/range~Range range instance} that is equal to this live range.
-     *
-     * @returns {module:engine/model/range~Range}
      */
     toRange() {
         return new Range(this.start, this.end);
     }
     /**
      * Creates a `LiveRange` instance that is equal to the given range.
-     *
-     * @param {module:engine/model/range~Range} range
-     * @returns {module:engine/model/liverange~LiveRange}
      */
     static fromRange(range) {
         return new LiveRange(range.start, range.end);
     }
 }
-/**
- * Checks whether this object is of the given.
- *
- *		liveRange.is( 'range' ); // -> true
- *		liveRange.is( 'model:range' ); // -> true
- *		liveRange.is( 'liveRange' ); // -> true
- *		liveRange.is( 'model:liveRange' ); // -> true
- *
- *		liveRange.is( 'view:range' ); // -> false
- *		liveRange.is( 'documentSelection' ); // -> false
- *
- * {@link module:engine/model/node~Node#is Check the entire list of model objects} which implement the `is()` method.
- *
- * @param {String} type
- * @returns {Boolean}
- */
+// The magic of type inference using `is` method is centralized in `TypeCheckable` class.
+// Proper overload would interfere with that.
 LiveRange.prototype.is = function (type) {
     return type === 'liveRange' || type === 'model:liveRange' ||
         // From super.is(). This is highly utilised method and cannot call super. See ckeditor/ckeditor5#6529.
         type == 'range' || type === 'model:range';
 };
-// Binds this `LiveRange` to the {@link module:engine/model/document~Document document}
-// that owns this range's {@link module:engine/model/range~Range#root root}.
-//
-// @private
+/**
+ * Binds this `LiveRange` to the {@link module:engine/model/document~Document document}
+ * that owns this range's {@link module:engine/model/range~Range#root root}.
+ */
 function bindWithDocument() {
     this.listenTo(this.root.document.model, 'applyOperation', (event, args) => {
         const operation = args[0];
@@ -85,10 +66,9 @@ function bindWithDocument() {
         transform.call(this, operation);
     }, { priority: 'low' });
 }
-// Updates this range accordingly to the updates applied to the model. Bases on change events.
-//
-// @private
-// @param {module:engine/model/operation/operation~Operation} operation Executed operation.
+/**
+ * Updates this range accordingly to the updates applied to the model. Bases on change events.
+ */
 function transform(operation) {
     // Transform the range by the operation. Join the result ranges if needed.
     const ranges = this.getTransformedByOperation(operation);
@@ -119,12 +99,9 @@ function transform(operation) {
         this.fire('change:content', this.toRange(), { deletionPosition });
     }
 }
-// Checks whether given operation changes something inside the range (even if it does not change boundaries).
-//
-// @private
-// @param {module:engine/model/range~Range} range Range to check.
-// @param {module:engine/model/operation/operation~Operation} operation Executed operation.
-// @returns {Boolean}
+/**
+ * Checks whether given operation changes something inside the range (even if it does not change boundaries).
+ */
 function doesOperationChangeRangeContent(range, operation) {
     switch (operation.type) {
         case 'insert':