Browse Source

#396: Update documentation and imports for deltas.

Maciej Gołaszewski 9 năm trước cách đây
mục cha
commit
0595d41738

+ 3 - 2
packages/ckeditor5-engine/src/treemodel/delta/attributedelta.js

@@ -5,9 +5,8 @@
 
 'use strict';
 
-import Delta from './delta.js';
+import { default as Delta, registerDeserializer } from './delta.js';
 import { register } from '../batch.js';
-import { registerDeserializer } from './delta.js';
 import AttributeOperation from '../operation/attributeoperation.js';
 import RootAttributeOperation from '../operation/rootattributeoperation.js';
 import Position from '../position.js';
@@ -70,6 +69,7 @@ export default class AttributeDelta extends Delta {
 		return AttributeDelta;
 	}
 
+	/** @inheritDoc */
 	static get className() {
 		return 'engine.treeModel.delta.AttributeDelta';
 	}
@@ -88,6 +88,7 @@ export default class AttributeDelta extends Delta {
  * @extends engine.treeModel.delta.Delta
  */
 export class RootAttributeDelta extends Delta {
+	/** @inheritDoc */
 	static get className() {
 		return 'engine.treeModel.delta.RootAttributeDelta';
 	}

+ 2 - 1
packages/ckeditor5-engine/src/treemodel/delta/delta.js

@@ -151,6 +151,7 @@ export default class Delta {
 	 * {@link engine.treeModel.delta.Delta.fromJSON} during deserialization.
 	 *
 	 * @type {String}
+	 * @readonly
 	 */
 	static get className() {
 		return 'engine.treeModel.delta.Delta';
@@ -169,7 +170,7 @@ export default class Delta {
 	}
 
 	/**
-	 * Creates InsertDelta from deserialized object, ie. from parsed JSON string
+	 * Creates InsertDelta from deserialized object, i.e. from parsed JSON string.
 	 *
 	 * @param {Object} json
 	 * @param {engine.treeModel.Document} doc Document on which this delta will be applied.

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

@@ -5,10 +5,9 @@
 
 'use strict';
 
-import Delta from './delta.js';
+import { default as Delta, registerDeserializer } from './delta.js';
 import RemoveDelta from './removedelta.js';
 import { register } from '../batch.js';
-import { registerDeserializer } from './delta.js';
 import InsertOperation from '../operation/insertoperation.js';
 
 /**
@@ -51,6 +50,7 @@ export default class InsertDelta extends Delta {
 		return RemoveDelta;
 	}
 
+	/** @inheritDoc */
 	static get className() {
 		return 'engine.treeModel.delta.InsertDelta';
 	}

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

@@ -5,10 +5,9 @@
 
 'use strict';
 
-import Delta from './delta.js';
+import { default as Delta, registerDeserializer } from './delta.js';
 import SplitDelta from './splitdelta.js';
 import { register } from '../batch.js';
-import { registerDeserializer } from './delta.js';
 import Position from '../position.js';
 import Element from '../element.js';
 import RemoveOperation from '../operation/removeoperation.js';
@@ -49,6 +48,7 @@ export default class MergeDelta extends Delta {
 		return SplitDelta;
 	}
 
+	/** @inheritDoc */
 	static get className() {
 		return 'engine.treeModel.delta.MergeDelta';
 	}

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

@@ -5,9 +5,8 @@
 
 'use strict';
 
-import Delta from './delta.js';
+import { default as Delta, registerDeserializer } from './delta.js';
 import { register } from '../batch.js';
-import { registerDeserializer } from './delta.js';
 import MoveOperation from '../operation/moveoperation.js';
 import Position from '../position.js';
 import Range from '../range.js';
@@ -66,6 +65,7 @@ export default class MoveDelta extends Delta {
 		return MoveDelta;
 	}
 
+	/** @inheritDoc */
 	static get className() {
 		return 'engine.treeModel.delta.MoveDelta';
 	}

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

@@ -20,6 +20,7 @@ import Range from '../range.js';
  * @memberOf engine.treeModel.delta
  */
 export default class RemoveDelta extends MoveDelta {
+	/** @inheritDoc */
 	static get className() {
 		return 'engine.treeModel.delta.RemoveDelta';
 	}

+ 2 - 2
packages/ckeditor5-engine/src/treemodel/delta/renamedelta.js

@@ -5,9 +5,8 @@
 
 'use strict';
 
-import Delta from './delta.js';
+import { default as Delta, registerDeserializer } from './delta.js';
 import { register } from '../batch.js';
-import { registerDeserializer } from './delta.js';
 import InsertOperation from '../operation/insertoperation.js';
 import RemoveOperation from '../operation/removeoperation.js';
 import MoveOperation from '../operation/moveoperation.js';
@@ -25,6 +24,7 @@ export default class RenameDelta extends Delta {
 		return RenameDelta;
 	}
 
+	/** @inheritDoc */
 	static get className() {
 		return 'engine.treeModel.delta.RenameDelta';
 	}

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

@@ -5,9 +5,8 @@
 
 'use strict';
 
-import Delta from './delta.js';
+import { default as Delta, registerDeserializer } from './delta.js';
 import { register } from '../batch.js';
-import { registerDeserializer } from './delta.js';
 import Position from '../position.js';
 import Element from '../element.js';
 import InsertOperation from '../operation/insertoperation.js';
@@ -62,6 +61,7 @@ export default class SplitDelta extends Delta {
 		return MergeDelta;
 	}
 
+	/** @inheritDoc */
 	static get className() {
 		return 'engine.treeModel.delta.SplitDelta';
 	}

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

@@ -5,10 +5,9 @@
 
 'use strict';
 
-import Delta from './delta.js';
+import { default as Delta, registerDeserializer } from './delta.js';
 import WrapDelta from './wrapdelta.js';
 import { register } from '../batch.js';
-import { registerDeserializer } from './delta.js';
 import Position from '../position.js';
 import RemoveOperation from '../operation/removeoperation.js';
 import MoveOperation from '../operation/moveoperation.js';
@@ -45,6 +44,7 @@ export default class UnwrapDelta extends Delta {
 		return WrapDelta;
 	}
 
+	/** @inheritDoc */
 	static get className() {
 		return 'engine.treeModel.delta.UnwrapDelta';
 	}

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

@@ -19,6 +19,7 @@ import NodeList from '../nodelist.js';
  * @memberOf engine.treeModel.delta
  */
 export default class WeakInsertDelta extends InsertDelta {
+	/** @inheritDoc */
 	static get className() {
 		return 'engine.treeModel.delta.WeakInsertDelta';
 	}

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

@@ -5,10 +5,9 @@
 
 'use strict';
 
-import Delta from './delta.js';
+import { default as Delta, registerDeserializer } from './delta.js';
 import UnwrapDelta from './unwrapdelta.js';
 import { register } from '../batch.js';
-import { registerDeserializer } from './delta.js';
 import Position from '../position.js';
 import Range from '../range.js';
 import Element from '../element.js';