Sfoglia il codice sorgente

Documentation: update core.treemodel.Delta documentation.

Maciej Gołaszewski 9 anni fa
parent
commit
d33881fe84

+ 1 - 1
packages/ckeditor5-engine/src/treemodel/batch-base.js

@@ -28,7 +28,7 @@ import CKEditorError from '../ckeditorerror.js';
  *
  *		doc.batch().insert( firstPosition, 'foo' ).insert( secondPosition, 'bar' );
  *
- * @class treeModel.Batch
+ * @class core.treeModel.Batch
  */
 export default class Batch {
 	/**

+ 8 - 9
packages/ckeditor5-engine/src/treemodel/delta/attributedelta.js

@@ -12,11 +12,12 @@ import Range from '../range.js';
 import Element from '../element.js';
 
 /**
- * To provide specific OT behavior and better collisions solving, change methods ({@link treeModel.Batch#setAttr}
- * and {@link treeModel.Batch#removeAttr}) use `AttributeDelta` class which inherits from the `Delta` class and may
+ * @classdesc To provide specific OT behavior and better collisions solving, change methods ({@link core.treeModel.Batch#setAttr}
+ * and {@link core.treeModel.Batch#removeAttr}) use `AttributeDelta` class which inherits from the `Delta` class and may
  * overwrite some methods.
  *
- * @class treeModel.delta.AttributeDelta
+ * @class core.treeModel.delta.AttributeDelta
+ * @extends core.treeModel.delta.Delta
  */
 export default class AttributeDelta extends Delta {}
 
@@ -24,11 +25,10 @@ export default class AttributeDelta extends Delta {}
  * Sets the value of the attribute of the node or on the range.
  *
  * @chainable
- * @method setAttr
- * @memberOf treeModel.Batch
+ * @method core.treeModel.Batch#setAttr
  * @param {String} key Attribute key.
  * @param {*} value Attribute new value.
- * @param {treeModel.Node|treeModel.Range} nodeOrRange Node or range on which the attribute will be set.
+ * @param {core.treeModel.Node|core.treeModel.Range} nodeOrRange Node or range on which the attribute will be set.
  */
 register( 'setAttr', function( key, value, nodeOrRange ) {
 	attribute( this, key, value, nodeOrRange );
@@ -40,10 +40,9 @@ register( 'setAttr', function( key, value, nodeOrRange ) {
  * Removes an attribute from the range.
  *
  * @chainable
- * @method removeAttr
- * @memberOf treeModel.Batch
+ * @method core.treeModel.Batch#removeAttr
  * @param {String} key Attribute key.
- * @param {treeModel.Node|treeModel.Range} nodeOrRange Node or range on which the attribute will be removed.
+ * @param {core.treeModel.Node|core.treeModel.Range} nodeOrRange Node or range on which the attribute will be removed.
  */
 register( 'removeAttr', function( key, nodeOrRange ) {
 	attribute( this, key, null, nodeOrRange );

+ 7 - 8
packages/ckeditor5-engine/src/treemodel/delta/delta.js

@@ -6,6 +6,9 @@
 'use strict';
 
 /**
+ * Creates a delta instance.
+ *
+ * @classdesc
  * Base class for all deltas.
  *
  * Delta is a single, from the user action point of view, change in the editable document, like insert, split or
@@ -13,14 +16,9 @@
  *
  * Multiple deltas are grouped into a single {@link treeModel.Batch}.
  *
- * @class treeModel.delta.Delta
+ * @class core.treeModel.delta.Delta
  */
 export default class Delta {
-	/**
-	 * Creates a delta instance.
-	 *
-	 * @constructor
-	 */
 	constructor() {
 		/**
 		 * {@link treeModel.Batch} which delta is a part of. This property is null by default and set by the
@@ -43,7 +41,8 @@ export default class Delta {
 	/**
 	 * Add operation to the delta.
 	 *
-	 * @param {treeModel.operation.Operation} operation Operation instance.
+	 * @method core.treeModel.delta.Delta#addOperation
+	 * @param {core.treeModel.operation.Operation} operation Operation instance.
 	 */
 	addOperation( operation ) {
 		operation.delta = this;
@@ -51,4 +50,4 @@ export default class Delta {
 
 		return operation;
 	}
-}
+}

+ 7 - 7
packages/ckeditor5-engine/src/treemodel/delta/insertdelta.js

@@ -10,10 +10,11 @@ import { register } from '../batch-base.js';
 import InsertOperation from '../operation/insertoperation.js';
 
 /**
- * To provide specific OT behavior and better collisions solving, the {@link treeModel.Batch#insert} method
+ * @classdesc
+ * To provide specific OT behavior and better collisions solving, the {@link core.treeModel.Batch#insert Batch#insert} method
  * uses the `InsertDelta` class which inherits from the `Delta` class and may overwrite some methods.
  *
- * @class treeModel.delta.InsertDelta
+ * @class core.treeModel.delta.InsertDelta
  */
 export default class InsertDelta extends Delta {}
 
@@ -21,11 +22,10 @@ export default class InsertDelta extends Delta {}
  * Inserts a node or nodes at the given position.
  *
  * @chainable
- * @memberOf treeModel.Batch
- * @method insert
- * @param {treeModel.Position} position Position of insertion.
- * @param {treeModel.NodeSet} nodes The list of nodes to be inserted.
- * List of nodes can be of any type accepted by the {@link treeModel.NodeList} constructor.
+ * @method core.treeModel.Batch#insert
+ * @param {core.treeModel.Position} position Position of insertion.
+ * @param {core.treeModel.NodeSet} nodes The list of nodes to be inserted.
+ * List of nodes can be of any type accepted by the {@link core.treeModel.NodeList} constructor.
  */
 register( 'insert', function( position, nodes ) {
 	const delta = new InsertDelta();

+ 5 - 5
packages/ckeditor5-engine/src/treemodel/delta/mergedelta.js

@@ -14,10 +14,11 @@ import MoveOperation from '../operation/moveoperation.js';
 import CKEditorError from '../../ckeditorerror.js';
 
 /**
- * To provide specific OT behavior and better collisions solving, {@link treeModel.Batch#merge} method
+ * @classdesc
+ * To provide specific OT behavior and better collisions solving, {@link core.treeModel.Batch#merge} method
  * uses the `MergeDelta` class which inherits from the `Delta` class and may overwrite some methods.
  *
- * @class treeModel.delta.MergeDelta
+ * @class core.treeModel.delta.MergeDelta
  */
 export default class MergeDelta extends Delta {}
 
@@ -28,9 +29,8 @@ export default class MergeDelta extends Delta {}
  * `batch-merge-no-element-after` error will be thrown.
  *
  * @chainable
- * @method merge
- * @memberOf treeModel.Batch
- * @param {treeModel.Position} position Position of merge.
+ * @method core.treeModel.Batch#merge
+ * @param {core.treeModel.Position} position Position of merge.
  */
 register( 'merge', function( position ) {
 	const delta = new MergeDelta();

+ 6 - 6
packages/ckeditor5-engine/src/treemodel/delta/movedelta.js

@@ -13,10 +13,11 @@ import Range from '../range.js';
 import CKEditorError from '../../ckeditorerror.js';
 
 /**
- * To provide specific OT behavior and better collisions solving, {@link treeModel.Batch#move} method
+ * @classdesc
+ * To provide specific OT behavior and better collisions solving, {@link core.treeModel.Batch#move} method
  * uses the `MoveDelta` class which inherits from the `Delta` class and may overwrite some methods.
  *
- * @class treeModel.delta.MoveDelta
+ * @class core.treeModel.delta.MoveDelta
  */
 export default class MoveDelta extends Delta {}
 
@@ -30,10 +31,9 @@ function addMoveOperation( batch, delta, sourcePosition, howMany, targetPosition
  * Moves given node or given range of nodes to target position.
  *
  * @chainable
- * @method move
- * @memberOf treeModel.Batch
- * @param {treeModel.Node|treeModel.Range} nodeOrRange Node or range of nodes to move.
- * @param {treeModel.Position} targetPosition Position where moved nodes will be inserted.
+ * @method core.treeModel.Batch#move
+ * @param {core.treeModel.Node|core.treeModel.Range} nodeOrRange Node or range of nodes to move.
+ * @param {core.treeModel.Position} targetPosition Position where moved nodes will be inserted.
  */
 register( 'move', function( nodeOrRange, targetPosition ) {
 	const delta = new MoveDelta();

+ 5 - 5
packages/ckeditor5-engine/src/treemodel/delta/removedelta.js

@@ -12,10 +12,11 @@ import Position from '../position.js';
 import Range from '../range.js';
 
 /**
- * To provide specific OT behavior and better collisions solving, {@link treeModel.Batch#remove} method
+ * @classdesc
+ * To provide specific OT behavior and better collisions solving, {@link core.treeModel.Batch#remove} method
  * uses the `RemoveDelta` class which inherits from the `Delta` class and may overwrite some methods.
  *
- * @class treeModel.delta.RemoveDelta
+ * @class core.treeModel.delta.RemoveDelta
  */
 export default class RemoveDelta extends Delta {}
 
@@ -29,9 +30,8 @@ function addRemoveOperation( batch, delta, position, howMany ) {
  * Removes given node or range of nodes.
  *
  * @chainable
- * @method remove
- * @memberOf treeModel.Batch
- * @param {treeModel.Node|treeModel.Range} nodeOrRange Node or range of nodes to remove.
+ * @method core.treeModel.Batch#remove
+ * @param {core.treeModel.Node|core.treeModel.Range} nodeOrRange Node or range of nodes to remove.
  */
 register( 'remove', function( nodeOrRange ) {
 	const delta = new RemoveDelta();

+ 5 - 5
packages/ckeditor5-engine/src/treemodel/delta/splitdelta.js

@@ -14,10 +14,11 @@ import MoveOperation from '../operation/moveoperation.js';
 import CKEditorError from '../../ckeditorerror.js';
 
 /**
- * To provide specific OT behavior and better collisions solving, the {@link treeModel.Batch#split} method
+ * @classdesc
+ * To provide specific OT behavior and better collisions solving, the {@link core.treeModel.Batch#split} method
  * uses `SplitDelta` class which inherits from the `Delta` class and may overwrite some methods.
  *
- * @class treeModel.delta.SplitDelta
+ * @class core.treeModel.delta.SplitDelta
  */
 export default class SplitDelta extends Delta {}
 
@@ -28,9 +29,8 @@ export default class SplitDelta extends Delta {}
  * you try to split the root element.
  *
  * @chainable
- * @method split
- * @memberOf treeModel.Batch
- * @param {treeModel.Position} position Position of split.
+ * @method core.treeModel.Batch#split
+ * @param {core.treeModel.Position} position Position of split.
  */
 register( 'split', function( position ) {
 	const delta = new SplitDelta();

+ 5 - 5
packages/ckeditor5-engine/src/treemodel/delta/unwrapdelta.js

@@ -13,10 +13,11 @@ import MoveOperation from '../operation/moveoperation.js';
 import CKEditorError from '../../ckeditorerror.js';
 
 /**
- * To provide specific OT behavior and better collisions solving, {@link treeModel.Batch#merge} method
+ * @classdesc
+ * To provide specific OT behavior and better collisions solving, {@link core.treeModel.Batch#merge} method
  * uses the `UnwrapDelta` class which inherits from the `Delta` class and may overwrite some methods.
  *
- * @class treeModel.delta.UnwrapDelta
+ * @class core.treeModel.delta.UnwrapDelta
  */
 export default class UnwrapDelta extends Delta {}
 
@@ -25,9 +26,8 @@ export default class UnwrapDelta extends Delta {}
  * error if you try to unwrap an element that does not have a parent.
  *
  * @chainable
- * @method unwrap
- * @memberOf treeModel.Batch
- * @param {treeModel.Element} position Element to unwrap.
+ * @method core.treeModel.Batch#unwrap
+ * @param {core.treeModel.Element} position Element to unwrap.
  */
 register( 'unwrap', function( element ) {
 	if ( element.parent === null ) {

+ 12 - 12
packages/ckeditor5-engine/src/treemodel/delta/weakinsertdelta.js

@@ -11,29 +11,29 @@ import InsertOperation from '../operation/insertoperation.js';
 import NodeList from '../nodelist.js';
 
 /**
- * To provide specific OT behavior and better collisions solving, the {@link treeModel.Batch#insert} method
+ * @classdesc
+ * To provide specific OT behavior and better collisions solving, the {@link core.treeModel.Batch#insert} method
  * uses the `WeakInsertDelta` class which inherits from the `Delta` class and may overwrite some methods.
  *
- * @class treeModel.delta.WeakInsertDelta
+ * @class core.treeModel.delta.WeakInsertDelta
  */
 export default class WeakInsertDelta extends Delta {}
 
 /**
- * Inserts a node or nodes at the given position. {@link treeModel.Batch#weakInsert} is commonly used for actions
+ * Inserts a node or nodes at the given position. {@link core.treeModel.Batch#weakInsert} is commonly used for actions
  * like typing or plain-text paste (without formatting). There are two differences between
- * {@link treeModel.Batch#insert} and {@link treeModel.Batch#weakInsert}:
+ * {@link core.treeModel.Batch#insert} and {@link core.treeModel.Batch#weakInsert}:
  * * When using `weakInsert`, inserted nodes will have same attributes as the current attributes of
- * {@link treeModel.Document#selection document selection}.
- * * The above has to be reflected during {@link treeModel.operation.transform operational transformation}. Normal
- * behavior is that inserting inside range changed by {@link treeModel.operation.AttributeOperation} splits the operation
+ * {@link core.treeModel.Document#selection document selection}.
+ * * The above has to be reflected during {@link core.treeModel.operation.transform operational transformation}. Normal
+ * behavior is that inserting inside range changed by {@link core.treeModel.operation.AttributeOperation} splits the operation
  * into two operations, which "omit" the inserted nodes. The correct behavior for `WeakInsertDelta` is that
- * {@link treeModel.operation.AttributeOperation} does not "break" and also applies attributes for inserted nodes.
+ * {@link core.treeModel.operation.AttributeOperation} does not "break" and also applies attributes for inserted nodes.
  *
  * @chainable
- * @memberOf treeModel.Batch
- * @method weakInsert
- * @param {treeModel.Position} position Position of insertion.
- * @param {treeModel.NodeSet} nodes The list of nodes to be inserted.
+ * @method core.treeModel.BatchweakInsert
+ * @param {core.treeModel.Position} position Position of insertion.
+ * @param {core.treeModel.NodeSet} nodes The list of nodes to be inserted.
  */
 register( 'weakInsert', function( position, nodes ) {
 	const delta = new WeakInsertDelta();

+ 7 - 7
packages/ckeditor5-engine/src/treemodel/delta/wrapdelta.js

@@ -14,22 +14,22 @@ import MoveOperation from '../operation/moveoperation.js';
 import CKEditorError from '../../ckeditorerror.js';
 
 /**
- * To provide specific OT behavior and better collisions solving, {@link treeModel.Batch#merge} method
+ * @classdesc
+ * To provide specific OT behavior and better collisions solving, {@link core.treeModel.Batch#merge} method
  * uses the `WrapDelta` class which inherits from the `Delta` class and may overwrite some methods.
  *
- * @class treeModel.delta.WrapDelta
+ * @class core.treeModel.delta.WrapDelta
  */
 export default class WrapDelta extends Delta {}
 
 /**
  * Wraps given range with given element or with a new element of specified name if string has been passed.
- * **Note:** given range should be a "flat range" (see {@link treeModel.Range#isFlat}). If not, error will be thrown.
+ * **Note:** given range should be a "flat range" (see {@link core.treeModel.Range#isFlat}). If not, error will be thrown.
  *
  * @chainable
- * @method wrap
- * @memberOf treeModel.Batch
- * @param {treeModel.Range} range Range to wrap.
- * @param {treeModel.Element|String} elementOrString Element or name of element to wrap the range with.
+ * @method core.treeModel.Batch#wrap
+ * @param {core.treeModel.Range} range Range to wrap.
+ * @param {core.treeModel.Element|String} elementOrString Element or name of element to wrap the range with.
  */
 register( 'wrap', function( range, elementOrString ) {
 	if ( !range.isFlat ) {