@ckeditor/ckeditor5-engine 35.4.0 → 36.0.0

package/src/model/operation/rootattributeoperation.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,50 +16,24 @@ import { CKEditorError } from '@ckeditor/ckeditor5-utils';
  * requires a range to change and root element can't
  * be a part of range because every {@link module:engine/model/position~Position} has to be inside a root.
  * {@link module:engine/model/position~Position} can't be created before a root element.
- *
- * @extends module:engine/model/operation/operation~Operation
  */
 export default class RootAttributeOperation extends Operation {
     /**
      * Creates an operation that changes, removes or adds attributes on root element.
      *
      * @see module:engine/model/operation/attributeoperation~AttributeOperation
-     * @param {module:engine/model/rootelement~RootElement} root Root element to change.
-     * @param {String} key Key of an attribute to change or remove.
-     * @param {*} oldValue Old value of the attribute with given key or `null` if adding a new attribute.
-     * @param {*} newValue New value to set for the attribute. If `null`, then the operation just removes the attribute.
-     * @param {Number|null} baseVersion Document {@link module:engine/model/document~Document#version} on which operation
+     * @param root Root element to change.
+     * @param key Key of an attribute to change or remove.
+     * @param oldValue Old value of the attribute with given key or `null` if adding a new attribute.
+     * @param newValue New value to set for the attribute. If `null`, then the operation just removes the 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(root, key, oldValue, newValue, baseVersion) {
         super(baseVersion);
-        /**
-         * Root element to change.
-         *
-         * @readonly
-         * @member {module:engine/model/rootelement~RootElement}
-         */
         this.root = root;
-        /**
-         * 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 adding a new attribute.
-         *
-         * @readonly
-         * @member {*}
-         */
         this.oldValue = oldValue;
-        /**
-         * New value to set for the attribute. If `null`, then the operation just removes the attribute.
-         *
-         * @readonly
-         * @member {*}
-         */
         this.newValue = newValue;
     }
     /**
@@ -79,15 +53,13 @@ export default class RootAttributeOperation extends Operation {
     /**
      * Creates and returns an operation that has the same parameters as this operation.
      *
-     * @returns {module:engine/model/operation/rootattributeoperation~RootAttributeOperation} Clone of this operation.
+     * @returns Clone of this operation.
      */
     clone() {
         return new RootAttributeOperation(this.root, this.key, this.oldValue, this.newValue, this.baseVersion);
     }
     /**
      * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
-     *
-     * @returns {module:engine/model/operation/rootattributeoperation~RootAttributeOperation}
      */
     getReversed() {
         return new RootAttributeOperation(this.root, this.key, this.newValue, this.oldValue, this.baseVersion + 1);
@@ -102,9 +74,9 @@ export default class RootAttributeOperation extends Operation {
              * The element to change is not a root element.
              *
              * @error rootattribute-operation-not-a-root
-             * @param {module:engine/model/rootelement~RootElement} root
-             * @param {String} key
-             * @param {*} value
+             * @param root
+             * @param key
+             * @param value
              */
             throw new CKEditorError('rootattribute-operation-not-a-root', this, { root: this.root, key: this.key });
         }
@@ -113,9 +85,9 @@ export default class RootAttributeOperation extends Operation {
              * The attribute which should be removed does not exists for the given node.
              *
              * @error rootattribute-operation-wrong-old-value
-             * @param {module:engine/model/rootelement~RootElement} root
-             * @param {String} key
-             * @param {*} value
+             * @param root
+             * @param key
+             * @param value
              */
             throw new CKEditorError('rootattribute-operation-wrong-old-value', this, { root: this.root, key: this.key });
         }
@@ -124,8 +96,8 @@ export default class RootAttributeOperation extends Operation {
              * The attribute with given key already exists for the given node.
              *
              * @error rootattribute-operation-attribute-exists
-             * @param {module:engine/model/rootelement~RootElement} root
-             * @param {String} key
+             * @param root
+             * @param key
              */
             throw new CKEditorError('rootattribute-operation-attribute-exists', this, { root: this.root, key: this.key });
         }
@@ -159,9 +131,8 @@ export default class RootAttributeOperation extends Operation {
     /**
      * Creates RootAttributeOperation 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/rootattributeoperation~RootAttributeOperation}
+     * @param json Deserialized JSON object.
+     * @param document Document on which this operation will be applied.
      */
     static fromJSON(json, document) {
         if (!document.getRoot(json.root)) {
@@ -169,7 +140,7 @@ export default class RootAttributeOperation extends Operation {
              * Cannot create RootAttributeOperation for document. Root with specified name does not exist.
              *
              * @error rootattribute-operation-fromjson-no-root
-             * @param {String} rootName
+             * @param rootName
              */
             throw new CKEditorError('rootattribute-operation-fromjson-no-root', this, { rootName: json.root });
         }

package/src/model/operation/splitoperation.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
  */
 /**
@@ -15,53 +15,27 @@ import { CKEditorError } from '@ckeditor/ckeditor5-utils';
  * Operation to split {@link module:engine/model/element~Element an element} at given
  * {@link module:engine/model/operation/splitoperation~SplitOperation#splitPosition split position} into two elements,
  * both containing a part of the element's original content.
- *
- * @extends module:engine/model/operation/operation~Operation
  */
 export default class SplitOperation extends Operation {
     /**
      * Creates a split operation.
      *
-     * @param {module:engine/model/position~Position} splitPosition Position at which an element should be split.
-     * @param {Number} howMany Total offset size of elements that are in the split element after `position`.
-     * @param {module:engine/model/position~Position} insertionPosition Position at which the clone of split element
-     * (or element from graveyard) will be inserted.
-     * @param {module:engine/model/position~Position|null} graveyardPosition Position in the graveyard root before the element which
+     * @param splitPosition Position at which an element should be split.
+     * @param howMany Total offset size of elements that are in the split element after `position`.
+     * @param insertionPosition Position at which the clone of split element (or element from graveyard) will be inserted.
+     * @param graveyardPosition Position in the graveyard root before the element which
      * should be used as a parent of the nodes after `position`. If it is not set, a copy of the the `position` parent will be used.
-     * @param {Number|null} baseVersion Document {@link module:engine/model/document~Document#version} on which operation
+     * @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(splitPosition, howMany, insertionPosition, graveyardPosition, baseVersion) {
         super(baseVersion);
-        /**
-         * Position at which an element should be split.
-         *
-         * @member {module:engine/model/position~Position} module:engine/model/operation/splitoperation~SplitOperation#splitPosition
-         */
         this.splitPosition = splitPosition.clone();
         // Keep position sticking to the next node. This way any new content added at the place where the element is split
         // will be left in the original element.
         this.splitPosition.stickiness = 'toNext';
-        /**
-         * Total offset size of elements that are in the split element after `position`.
-         *
-         * @member {Number} module:engine/model/operation/splitoperation~SplitOperation#howMany
-         */
         this.howMany = howMany;
-        /**
-         * Position at which the clone of split element (or element from graveyard) will be inserted.
-         *
-         * @member {module:engine/model/position~Position} module:engine/model/operation/splitoperation~SplitOperation#insertionPosition
-         */
         this.insertionPosition = insertionPosition;
-        /**
-         * Position in the graveyard root before the element which should be used as a parent of the nodes after `position`.
-         * If it is not set, a copy of the the `position` parent will be used.
-         *
-         * The default behavior is to clone the split element. Element from graveyard is used during undo.
-         *
-         * @member {module:engine/model/position~Position|null} #graveyardPosition
-         */
         this.graveyardPosition = graveyardPosition ? graveyardPosition.clone() : null;
         if (this.graveyardPosition) {
             this.graveyardPosition.stickiness = 'toNext';
@@ -77,9 +51,6 @@ export default class SplitOperation extends Operation {
      * Position inside the new clone of a split element.
      *
      * This is a position where nodes that are after the split position will be moved to.
-     *
-     * @readonly
-     * @type {module:engine/model/position~Position}
      */
     get moveTargetPosition() {
         const path = this.insertionPosition.path.slice();
@@ -89,9 +60,6 @@ export default class SplitOperation extends Operation {
     /**
      * Artificial range that contains all the nodes from the split element that will be moved to the new element.
      * The range starts at {@link ~#splitPosition} and ends in the same parent, at `POSITIVE_INFINITY` offset.
-     *
-     * @readonly
-     * @type {module:engine/model/range~Range}
      */
     get movedRange() {
         const end = this.splitPosition.getShiftedBy(Number.POSITIVE_INFINITY);
@@ -100,15 +68,13 @@ export default class SplitOperation extends Operation {
     /**
      * Creates and returns an operation that has the same parameters as this operation.
      *
-     * @returns {module:engine/model/operation/splitoperation~SplitOperation} Clone of this operation.
+     * @returns Clone of this operation.
      */
     clone() {
         return new SplitOperation(this.splitPosition, this.howMany, this.insertionPosition, this.graveyardPosition, this.baseVersion);
     }
     /**
      * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
-     *
-     * @returns {module:engine/model/operation/mergeoperation~MergeOperation}
      */
     getReversed() {
         const graveyard = this.splitPosition.root.document.graveyard;
@@ -193,9 +159,6 @@ export default class SplitOperation extends Operation {
     /**
      * Helper function that returns a default insertion position basing on given `splitPosition`. The default insertion
      * position is after the split element.
-     *
-     * @param {module:engine/model/position~Position} splitPosition
-     * @returns {module:engine/model/position~Position}
      */
     static getInsertionPosition(splitPosition) {
         const path = splitPosition.path.slice(0, -1);
@@ -205,9 +168,8 @@ export default class SplitOperation extends Operation {
     /**
      * Creates `SplitOperation` 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/splitoperation~SplitOperation}
+     * @param json Deserialized JSON object.
+     * @param document Document on which this operation will be applied.
      */
     static fromJSON(json, document) {
         const splitPosition = Position.fromJSON(json.splitPosition, document);