8
0
Quellcode durchsuchen

Docs: deltas classes descriptions.

Piotr Jasiun vor 10 Jahren
Ursprung
Commit
0f0a9411a1

+ 4 - 0
packages/ckeditor5-engine/src/document/delta/changedelta.js

@@ -13,6 +13,10 @@ CKEDITOR.define( [
 	'document/attribute'
 ], ( Delta, register, ChangeOperation, Range, Attribute ) => {
 	/**
+	 * To provide specific OT behavior and better collisions solving, change methods ({@link document.Transaction#setAttr}
+	 * and {@link document.Transaction#removeAttr}) use `ChangeDelta` class which inherit from `Delta` class and may
+	 * overwrite some methods.
+	 *
 	 * @class document.delta.ChangeDelta
 	 */
 	class ChangeDelta extends Delta {}

+ 3 - 0
packages/ckeditor5-engine/src/document/delta/insertdelta.js

@@ -11,6 +11,9 @@ CKEDITOR.define( [
 	'document/operation/insertoperation'
 ], ( Delta, register, InsertOperation ) => {
 	/**
+	 * To provide specific OT behavior and better collisions solving, {@link document.Transaction#insert} method
+	 * use `InsertDelta` class which inherit from `Delta` class and may overwrite some methods.
+	 *
 	 * @class document.delta.InsertDelta
 	 */
 	class InsertDelta extends Delta {}

+ 3 - 0
packages/ckeditor5-engine/src/document/delta/mergedelta.js

@@ -15,6 +15,9 @@ CKEDITOR.define( [
 	'ckeditorerror'
 ], ( Delta, register, Position, Element, RemoveOperation, MoveOperation, CKEditorError ) => {
 	/**
+	 * To provide specific OT behavior and better collisions solving, {@link document.Transaction#merge} method
+	 * use `MergeDelta` class which inherit from `Delta` class and may overwrite some methods.
+	 *
 	 * @class document.delta.MergeDelta
 	 */
 	class MergeDelta extends Delta {}

+ 3 - 0
packages/ckeditor5-engine/src/document/delta/removedelta.js

@@ -11,6 +11,9 @@ CKEDITOR.define( [
 	'document/operation/removeoperation'
 ], ( Delta, register, RemoveOperation ) => {
 	/**
+	 * To provide specific OT behavior and better collisions solving, {@link document.Transaction#remove} method
+	 * use `RemoveDelta` class which inherit from `Delta` class and may overwrite some methods.
+	 *
 	 * @class document.delta.RemoveDelta
 	 */
 	class RemoveDelta extends Delta {}

+ 3 - 0
packages/ckeditor5-engine/src/document/delta/splitdelta.js

@@ -15,6 +15,9 @@ CKEDITOR.define( [
 	'ckeditorerror'
 ], ( Delta, register, Position, Element, InsertOperation, MoveOperation, CKEditorError ) => {
 	/**
+	 * To provide specific OT behavior and better collisions solving, {@link document.Transaction#split} method
+	 * use `SplitDelta` class which inherit from `Delta` class and may overwrite some methods.
+	 *
 	 * @class document.delta.SplitDelta
 	 */
 	class SplitDelta extends Delta {}