@ckeditor/ckeditor5-engine 35.4.0 → 36.0.1

package/src/model/node.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
  */
 /* eslint-disable @typescript-eslint/no-unused-vars */
@@ -44,8 +44,7 @@ export default class Node extends TypeCheckable {
      *
      * This is an abstract class, so this constructor should not be used directly.
      *
-     * @abstract
-     * @param {Object} [attrs] Node's attributes. See {@link module:utils/tomap~toMap} for a list of accepted values.
+     * @param attrs Node's attributes. See {@link module:utils/tomap~toMap} for a list of accepted values.
      */
     constructor(attrs) {
         super();
@@ -53,24 +52,12 @@ export default class Node extends TypeCheckable {
          * Parent of this node. It could be {@link module:engine/model/element~Element}
          * or {@link module:engine/model/documentfragment~DocumentFragment}.
          * Equals to `null` if the node has no parent.
-         *
-         * @readonly
-         * @member {module:engine/model/element~Element|module:engine/model/documentfragment~DocumentFragment|null}
          */
         this.parent = null;
-        /**
-         * Attributes set on this node.
-         *
-         * @private
-         * @member {Map} module:engine/model/node~Node#_attrs
-         */
         this._attrs = toMap(attrs);
     }
     /**
      * {@link module:engine/model/document~Document Document} that owns this root element.
-     *
-     * @readonly
-     * @type {module:engine/model/document~Document|null}
      */
     get document() {
         return null;
@@ -80,9 +67,6 @@ export default class Node extends TypeCheckable {
      *
      * Accessing this property throws an error if this node's parent element does not contain it.
      * This means that model tree got broken.
-     *
-     * @readonly
-     * @type {Number|null}
      */
     get index() {
         let pos;
@@ -100,9 +84,6 @@ export default class Node extends TypeCheckable {
      *
      * Accessing this property throws an error if this node's parent element does not contain it.
      * This means that model tree got broken.
-     *
-     * @readonly
-     * @type {Number|null}
      */
     get startOffset() {
         let pos;
@@ -119,9 +100,6 @@ export default class Node extends TypeCheckable {
      * It is important for {@link module:engine/model/position~Position position}. When node has `offsetSize` greater than `1`, position
      * can be placed between that node start and end. `offsetSize` greater than `1` is for nodes that represents more
      * than one entity, i.e. {@link module:engine/model/text~Text text node}.
-     *
-     * @readonly
-     * @type {Number}
      */
     get offsetSize() {
         return 1;
@@ -130,9 +108,6 @@ export default class Node extends TypeCheckable {
      * Offset at which this node ends in it's parent. It is equal to the sum of this node's
      * {@link module:engine/model/node~Node#startOffset start offset} and {@link #offsetSize offset size}.
      * Equals to `null` if the node has no parent.
-     *
-     * @readonly
-     * @type {Number|null}
      */
     get endOffset() {
         if (!this.parent) {
@@ -142,9 +117,6 @@ export default class Node extends TypeCheckable {
     }
     /**
      * Node's next sibling or `null` if the node is a last child of it's parent or if the node has no parent.
-     *
-     * @readonly
-     * @type {module:engine/model/node~Node|null}
      */
     get nextSibling() {
         const index = this.index;
@@ -152,9 +124,6 @@ export default class Node extends TypeCheckable {
     }
     /**
      * Node's previous sibling or `null` if the node is a first child of it's parent or if the node has no parent.
-     *
-     * @readonly
-     * @type {module:engine/model/node~Node|null}
      */
     get previousSibling() {
         const index = this.index;
@@ -163,9 +132,6 @@ export default class Node extends TypeCheckable {
     /**
      * The top-most ancestor of the node. If node has no parent it is the root itself. If the node is a part
      * of {@link module:engine/model/documentfragment~DocumentFragment}, it's `root` is equal to that `DocumentFragment`.
-     *
-     * @readonly
-     * @type {module:engine/model/node~Node|module:engine/model/documentfragment~DocumentFragment}
      */
     get root() {
         // eslint-disable-next-line @typescript-eslint/no-this-alias, consistent-this
@@ -177,8 +143,6 @@ export default class Node extends TypeCheckable {
     }
     /**
      * Returns true if the node is in a tree rooted in the document (is a descendant of one of its roots).
-     *
-     * @returns {Boolean}
      */
     isAttached() {
         return this.root.is('rootElement');
@@ -188,16 +152,16 @@ export default class Node extends TypeCheckable {
      * beginning from {@link module:engine/model/node~Node#root root}, down to this node's starting offset. The path can be used to
      * create {@link module:engine/model/position~Position Position} instance.
      *
-     *		const abc = new Text( 'abc' );
-     *		const foo = new Text( 'foo' );
-     *		const h1 = new Element( 'h1', null, new Text( 'header' ) );
-     *		const p = new Element( 'p', null, [ abc, foo ] );
-     *		const div = new Element( 'div', null, [ h1, p ] );
-     *		foo.getPath(); // Returns [ 1, 3 ]. `foo` is in `p` which is in `div`. `p` starts at offset 1, while `foo` at 3.
-     *		h1.getPath(); // Returns [ 0 ].
-     *		div.getPath(); // Returns [].
-     *
-     * @returns {Array.<Number>} The path.
+     * ```ts
+     * const abc = new Text( 'abc' );
+     * const foo = new Text( 'foo' );
+     * const h1 = new Element( 'h1', null, new Text( 'header' ) );
+     * const p = new Element( 'p', null, [ abc, foo ] );
+     * const div = new Element( 'div', null, [ h1, p ] );
+     * foo.getPath(); // Returns [ 1, 3 ]. `foo` is in `p` which is in `div`. `p` starts at offset 1, while `foo` at 3.
+     * h1.getPath(); // Returns [ 0 ].
+     * div.getPath(); // Returns [].
+     * ```
      */
     getPath() {
         const path = [];
@@ -212,11 +176,11 @@ export default class Node extends TypeCheckable {
     /**
      * Returns ancestors array of this node.
      *
-     * @param {Object} options Options object.
-     * @param {Boolean} [options.includeSelf=false] When set to `true` this node will be also included in parent's array.
-     * @param {Boolean} [options.parentFirst=false] When set to `true`, array will be sorted from node's parent to root element,
+     * @param options Options object.
+     * @param options.includeSelf When set to `true` this node will be also included in parent's array.
+     * @param options.parentFirst When set to `true`, array will be sorted from node's parent to root element,
      * otherwise root element will be the first item in the array.
-     * @returns {Array} Array with ancestors.
+     * @returns Array with ancestors.
      */
     getAncestors(options = {}) {
         const ancestors = [];
@@ -231,11 +195,10 @@ export default class Node extends TypeCheckable {
      * Returns a {@link module:engine/model/element~Element} or {@link module:engine/model/documentfragment~DocumentFragment}
      * which is a common ancestor of both nodes.
      *
-     * @param {module:engine/model/node~Node} node The second node.
-     * @param {Object} options Options object.
-     * @param {Boolean} [options.includeSelf=false] When set to `true` both nodes will be considered "ancestors" too.
+     * @param node The second node.
+     * @param options Options object.
+     * @param options.includeSelf When set to `true` both nodes will be considered "ancestors" too.
      * Which means that if e.g. node A is inside B, then their common ancestor will be B.
-     * @returns {module:engine/model/element~Element|module:engine/model/documentfragment~DocumentFragment|null}
      */
     getCommonAncestor(node, options = {}) {
         const ancestorsA = this.getAncestors(options);
@@ -250,8 +213,7 @@ export default class Node extends TypeCheckable {
      * Returns whether this node is before given node. `false` is returned if nodes are in different trees (for example,
      * in different {@link module:engine/model/documentfragment~DocumentFragment}s).
      *
-     * @param {module:engine/model/node~Node} node Node to compare with.
-     * @returns {Boolean}
+     * @param node Node to compare with.
      */
     isBefore(node) {
         // Given node is not before this node if they are same.
@@ -278,8 +240,7 @@ export default class Node extends TypeCheckable {
      * Returns whether this node is after given node. `false` is returned if nodes are in different trees (for example,
      * in different {@link module:engine/model/documentfragment~DocumentFragment}s).
      *
-     * @param {module:engine/model/node~Node} node Node to compare with.
-     * @returns {Boolean}
+     * @param node Node to compare with.
      */
     isAfter(node) {
         // Given node is not before this node if they are same.
@@ -296,8 +257,8 @@ export default class Node extends TypeCheckable {
     /**
      * Checks if the node has an attribute with given key.
      *
-     * @param {String} key Key of attribute to check.
-     * @returns {Boolean} `true` if attribute with given key is set on node, `false` otherwise.
+     * @param key Key of attribute to check.
+     * @returns `true` if attribute with given key is set on node, `false` otherwise.
      */
     hasAttribute(key) {
         return this._attrs.has(key);
@@ -305,8 +266,8 @@ export default class Node extends TypeCheckable {
     /**
      * Gets an attribute value for given key or `undefined` if that attribute is not set on node.
      *
-     * @param {String} key Key of attribute to look for.
-     * @returns {*} Attribute value or `undefined`.
+     * @param key Key of attribute to look for.
+     * @returns Attribute value or `undefined`.
      */
     getAttribute(key) {
         return this._attrs.get(key);
@@ -316,16 +277,12 @@ export default class Node extends TypeCheckable {
      *
      * Attributes are returned as arrays containing two items. First one is attribute key and second is attribute value.
      * This format is accepted by native `Map` object and also can be passed in `Node` constructor.
-     *
-     * @returns {Iterable.<*>}
      */
     getAttributes() {
         return this._attrs.entries();
     }
     /**
      * Returns iterator that iterates over this node's attribute keys.
-     *
-     * @returns {Iterable.<String>}
      */
     getAttributeKeys() {
         return this._attrs.keys();
@@ -333,7 +290,7 @@ export default class Node extends TypeCheckable {
     /**
      * Converts `Node` to plain object and returns it.
      *
-     * @returns {Object} `Node` converted to plain object.
+     * @returns `Node` converted to plain object.
      */
     toJSON() {
         const json = {};
@@ -351,18 +308,16 @@ export default class Node extends TypeCheckable {
      * Creates a copy of this node, that is a node with exactly same attributes, and returns it.
      *
      * @internal
-     * @protected
-     * @returns {module:engine/model/node~Node} Node with same attributes as this node.
+     * @returns Node with same attributes as this node.
      */
     _clone(_deep) {
-        return new Node(this._attrs);
+        return new this.constructor(this._attrs);
     }
     /**
      * Removes this node from it's parent.
      *
      * @internal
      * @see module:engine/model/writer~Writer#remove
-     * @protected
      */
     _remove() {
         this.parent._removeChildren(this.index);
@@ -372,9 +327,8 @@ export default class Node extends TypeCheckable {
      *
      * @see module:engine/model/writer~Writer#setAttribute
      * @internal
-     * @protected
-     * @param {String} key Key of attribute to set.
-     * @param {*} value Attribute value.
+     * @param key Key of attribute to set.
+     * @param value Attribute value.
      */
     _setAttribute(key, value) {
         this._attrs.set(key, value);
@@ -384,8 +338,7 @@ export default class Node extends TypeCheckable {
      *
      * @see module:engine/model/writer~Writer#setAttributes
      * @internal
-     * @protected
-     * @param {Object} [attrs] Attributes to set. See {@link module:utils/tomap~toMap} for a list of accepted values.
+     * @param attrs Attributes to set. See {@link module:utils/tomap~toMap} for a list of accepted values.
      */
     _setAttributesTo(attrs) {
         this._attrs = toMap(attrs);
@@ -395,9 +348,8 @@ export default class Node extends TypeCheckable {
      *
      * @see module:engine/model/writer~Writer#removeAttribute
      * @internal
-     * @protected
-     * @param {String} key Key of attribute to remove.
-     * @returns {Boolean} `true` if the attribute was set on the element, `false` otherwise.
+     * @param key Key of attribute to remove.
+     * @returns `true` if the attribute was set on the element, `false` otherwise.
      */
     _removeAttribute(key) {
         return this._attrs.delete(key);
@@ -407,55 +359,13 @@ export default class Node extends TypeCheckable {
      *
      * @see module:engine/model/writer~Writer#clearAttributes
      * @internal
-     * @protected
      */
     _clearAttributes() {
         this._attrs.clear();
     }
 }
-/**
- * Checks whether this object is of the given type.
- *
- * This method is useful when processing model objects that are of unknown type. For example, a function
- * may return a {@link module:engine/model/documentfragment~DocumentFragment} or a {@link module:engine/model/node~Node}
- * that can be either a text node or an element. This method can be used to check what kind of object is returned.
- *
- *		someObject.is( 'element' ); // -> true if this is an element
- *		someObject.is( 'node' ); // -> true if this is a node (a text node or an element)
- *		someObject.is( 'documentFragment' ); // -> true if this is a document fragment
- *
- * Since this method is also available on a range of view objects, you can prefix the type of the object with
- * `model:` or `view:` to check, for example, if this is the model's or view's element:
- *
- *		modelElement.is( 'model:element' ); // -> true
- *		modelElement.is( 'view:element' ); // -> false
- *
- * By using this method it is also possible to check a name of an element:
- *
- *		imageElement.is( 'element', 'imageBlock' ); // -> true
- *		imageElement.is( 'element', 'imageBlock' ); // -> same as above
- *		imageElement.is( 'model:element', 'imageBlock' ); // -> same as above, but more precise
- *
- * The list of model objects which implement the `is()` method:
- *
- * * {@link module:engine/model/node~Node#is `Node#is()`}
- * * {@link module:engine/model/text~Text#is `Text#is()`}
- * * {@link module:engine/model/element~Element#is `Element#is()`}
- * * {@link module:engine/model/rootelement~RootElement#is `RootElement#is()`}
- * * {@link module:engine/model/position~Position#is `Position#is()`}
- * * {@link module:engine/model/liveposition~LivePosition#is `LivePosition#is()`}
- * * {@link module:engine/model/range~Range#is `Range#is()`}
- * * {@link module:engine/model/liverange~LiveRange#is `LiveRange#is()`}
- * * {@link module:engine/model/documentfragment~DocumentFragment#is `DocumentFragment#is()`}
- * * {@link module:engine/model/selection~Selection#is `Selection#is()`}
- * * {@link module:engine/model/documentselection~DocumentSelection#is `DocumentSelection#is()`}
- * * {@link module:engine/model/markercollection~Marker#is `Marker#is()`}
- * * {@link module:engine/model/textproxy~TextProxy#is `TextProxy#is()`}
- *
- * @method #is
- * @param {String} type Type to check.
- * @returns {Boolean}
- */
+// The magic of type inference using `is` method is centralized in `TypeCheckable` class.
+// Proper overload would interfere with that.
 Node.prototype.is = function (type) {
     return type === 'node' || type === 'model:node';
 };

package/src/model/nodelist.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,15 +16,12 @@ export default class NodeList {
     /**
      * Creates an empty node list.
      *
-     * @protected
-     * @param {Iterable.<module:engine/model/node~Node>} [nodes] Nodes contained in this node list.
+     * @internal
+     * @param nodes Nodes contained in this node list.
      */
     constructor(nodes) {
         /**
          * Nodes contained in this node list.
-         *
-         * @private
-         * @member {Array.<module:engine/model/node~Node>}
          */
         this._nodes = [];
         if (nodes) {
@@ -35,44 +32,30 @@ export default class NodeList {
      * Iterable interface.
      *
      * Iterates over all nodes contained inside this node list.
-     *
-     * @returns {Iterator.<module:engine/model/node~Node>}
      */
     [Symbol.iterator]() {
         return this._nodes[Symbol.iterator]();
     }
     /**
      * Number of nodes contained inside this node list.
-     *
-     * @readonly
-     * @type {Number}
      */
     get length() {
         return this._nodes.length;
     }
     /**
      * Sum of {@link module:engine/model/node~Node#offsetSize offset sizes} of all nodes contained inside this node list.
-     *
-     * @readonly
-     * @type {Number}
      */
     get maxOffset() {
         return this._nodes.reduce((sum, node) => sum + node.offsetSize, 0);
     }
     /**
      * Gets the node at the given index. Returns `null` if incorrect index was passed.
-     *
-     * @param {Number} index Index of node.
-     * @returns {module:engine/model/node~Node|null} Node at given index.
      */
     getNode(index) {
         return this._nodes[index] || null;
     }
     /**
      * Returns an index of the given node. Returns `null` if given node is not inside this node list.
-     *
-     * @param {module:engine/model/node~Node} node Child node to look for.
-     * @returns {Number|null} Child node's index.
      */
     getNodeIndex(node) {
         const index = this._nodes.indexOf(node);
@@ -81,9 +64,6 @@ export default class NodeList {
     /**
      * Returns the starting offset of given node. Starting offset is equal to the sum of
      * {@link module:engine/model/node~Node#offsetSize offset sizes} of all nodes that are before this node in this node list.
-     *
-     * @param {module:engine/model/node~Node} node Node to look for.
-     * @returns {Number|null} Node's starting offset.
      */
     getNodeStartOffset(node) {
         const index = this.getNodeIndex(node);
@@ -94,9 +74,6 @@ export default class NodeList {
      *
      * Returns starting offset of a node that is at given index. Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError}
      * `model-nodelist-index-out-of-bounds` if given index is less than `0` or more than {@link #length}.
-     *
-     * @param {Number} index Node's index.
-     * @returns {Number} Node's starting offset.
      */
     indexToOffset(index) {
         if (index == this._nodes.length) {
@@ -118,9 +95,6 @@ export default class NodeList {
      *
      * Returns index of a node that occupies given offset. Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError}
      * `model-nodelist-offset-out-of-bounds` if given offset is less than `0` or more than {@link #maxOffset}.
-     *
-     * @param {Number} offset Offset to look for.
-     * @returns {Number} Index of a node that occupies given offset.
      */
     offsetToIndex(offset) {
         let totalOffset = 0;
@@ -135,8 +109,8 @@ export default class NodeList {
              * Given offset cannot be found in the node list.
              *
              * @error model-nodelist-offset-out-of-bounds
-             * @param {Number} offset
-             * @param {module:engine/model/nodelist~NodeList} nodeList Stringified node list.
+             * @param offset
+             * @param nodeList Stringified node list.
              */
             throw new CKEditorError('model-nodelist-offset-out-of-bounds', this, {
                 offset,
@@ -149,9 +123,8 @@ export default class NodeList {
      * Inserts given nodes at given index.
      *
      * @internal
-     * @protected
-     * @param {Number} index Index at which nodes should be inserted.
-     * @param {Iterable.<module:engine/model/node~Node>} nodes Nodes to be inserted.
+     * @param index Index at which nodes should be inserted.
+     * @param nodes Nodes to be inserted.
      */
     _insertNodes(index, nodes) {
         // Validation.
@@ -171,10 +144,9 @@ export default class NodeList {
      * Removes one or more nodes starting at the given index.
      *
      * @internal
-     * @protected
-     * @param {Number} indexStart 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.
+     * @param indexStart Index of the first node to remove.
+     * @param howMany Number of nodes to remove.
+     * @returns Array containing removed nodes.
      */
     _removeNodes(indexStart, howMany = 1) {
         return this._nodes.splice(indexStart, howMany);
@@ -183,7 +155,7 @@ export default class NodeList {
      * Converts `NodeList` instance to an array containing nodes that were inserted in the node list. Nodes
      * are also converted to their plain object representation.
      *
-     * @returns {Array.<module:engine/model/node~Node>} `NodeList` instance converted to `Array`.
+     * @returns `NodeList` instance converted to `Array`.
      */
     toJSON() {
         return this._nodes.map(node => node.toJSON());

package/src/model/operation/attributeoperation.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
  */
 /**
@@ -14,8 +14,6 @@ import { isEqual } from 'lodash-es';
  * Operation to change nodes' attribute.
  *
  * Using this class you can add, remove or change value of the attribute.
- *
- * @extends module:engine/model/operation/operation~Operation
  */
 export default class AttributeOperation extends Operation {
     /**
@@ -30,42 +28,18 @@ export default class AttributeOperation extends Operation {
      * If both `newValue` and `oldValue` are set, then the operation will change the attribute value. Note that all nodes in
      * operation's ranges must already have an attribute with given key and `oldValue` as value
      *
-     * @param {module:engine/model/range~Range} range Range on which the operation should be applied. Must be a flat range.
-     * @param {String} key Key of an attribute to change or remove.
-     * @param {*} oldValue Old value of the attribute with given key or `null`, if attribute was not set before.
-     * @param {*} newValue New value of the attribute with given key or `null`, if operation should remove attribute.
-     * @param {Number|null} baseVersion Document {@link module:engine/model/document~Document#version} on which operation
+     * @param range Range on which the operation should be applied. Must be a flat range.
+     * @param key Key of an attribute to change or remove.
+     * @param oldValue Old value of the attribute with given key or `null`, if attribute was not set before.
+     * @param newValue New value of the attribute with given key or `null`, if operation should remove attribute.
+     * @param baseVersion Document {@link module:engine/model/document~Document#version} on which operation
      * can be applied or `null` if the operation operates on detached (non-document) tree.
      */
     constructor(range, key, oldValue, newValue, baseVersion) {
         super(baseVersion);
-        /**
-         * Range on which operation should be applied.
-         *
-         * @readonly
-         * @member {module:engine/model/range~Range}
-         */
         this.range = range.clone();
-        /**
-         * Key of an attribute to change or remove.
-         *
-         * @readonly
-         * @member {String}
-         */
         this.key = key;
-        /**
-         * Old value of the attribute with given key or `null`, if attribute was not set before.
-         *
-         * @readonly
-         * @member {*}
-         */
         this.oldValue = oldValue === undefined ? null : oldValue;
-        /**
-         * New value of the attribute with given key or `null`, if operation should remove attribute.
-         *
-         * @readonly
-         * @member {*}
-         */
         this.newValue = newValue === undefined ? null : newValue;
     }
     /**
@@ -84,16 +58,12 @@ export default class AttributeOperation extends Operation {
     }
     /**
      * Creates and returns an operation that has the same parameters as this operation.
-     *
-     * @returns {module:engine/model/operation/attributeoperation~AttributeOperation} Clone of this operation.
      */
     clone() {
         return new AttributeOperation(this.range, this.key, this.oldValue, this.newValue, this.baseVersion);
     }
     /**
      * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
-     *
-     * @returns {module:engine/model/operation/attributeoperation~AttributeOperation}
      */
     getReversed() {
         return new AttributeOperation(this.range, this.key, this.newValue, this.oldValue, this.baseVersion + 1);
@@ -125,9 +95,9 @@ export default class AttributeOperation extends Operation {
                  * Changed node has different attribute value than operation's old attribute value.
                  *
                  * @error attribute-operation-wrong-old-value
-                 * @param {module:engine/model/item~Item} item
-                 * @param {String} key
-                 * @param {*} value
+                 * @param item
+                 * @param key
+                 * @param value
                  */
                 throw new CKEditorError('attribute-operation-wrong-old-value', this, { item, key: this.key, value: this.oldValue });
             }
@@ -136,8 +106,8 @@ export default class AttributeOperation extends Operation {
                  * The attribute with given key already exists for the given node.
                  *
                  * @error attribute-operation-attribute-exists
-                 * @param {module:engine/model/node~Node} node
-                 * @param {String} key
+                 * @param node
+                 * @param key
                  */
                 throw new CKEditorError('attribute-operation-attribute-exists', this, { node: item, key: this.key });
             }
@@ -163,9 +133,8 @@ export default class AttributeOperation extends Operation {
     /**
      * Creates `AttributeOperation` object from deserilized object, i.e. from parsed JSON string.
      *
-     * @param {Object} json Deserialized JSON object.
-     * @param {module:engine/model/document~Document} document Document on which this operation will be applied.
-     * @returns {module:engine/model/operation/attributeoperation~AttributeOperation}
+     * @param json Deserialized JSON object.
+     * @param document Document on which this operation will be applied.
      */
     static fromJSON(json, document) {
         return new AttributeOperation(Range.fromJSON(json.range, document), json.key, json.oldValue, json.newValue, json.baseVersion);

package/src/model/operation/detachoperation.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
  */
 /**
@@ -13,31 +13,18 @@ import { CKEditorError } from '@ckeditor/ckeditor5-utils';
 /**
  * Operation to permanently remove node from detached root.
  * Note this operation is only a local operation and won't be send to the other clients.
- *
- * @extends module:engine/model/operation/operation~Operation
  */
 export default class DetachOperation extends Operation {
     /**
      * Creates an insert operation.
      *
-     * @param {module:engine/model/position~Position} sourcePosition
-     * Position before the first {@link module:engine/model/item~Item model item} to move.
-     * @param {Number} howMany Offset size of moved range. Moved range will start from `sourcePosition` and end at
+     * @param sourcePosition Position before the first {@link module:engine/model/item~Item model item} to move.
+     * @param howMany Offset size of moved range. Moved range will start from `sourcePosition` and end at
      * `sourcePosition` with offset shifted by `howMany`.
      */
     constructor(sourcePosition, howMany) {
         super(null);
-        /**
-         * Position before the first {@link module:engine/model/item~Item model item} to detach.
-         *
-         * @member {module:engine/model/position~Position} #sourcePosition
-         */
         this.sourcePosition = sourcePosition.clone();
-        /**
-         * Offset size of moved range.
-         *
-         * @member {Number} #howMany
-         */
         this.howMany = howMany;
     }
     /**