浏览代码

Docs: core.treeModel.

Szymon Cofalik 9 年之前
父节点
当前提交
dc67984314

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

@@ -58,6 +58,7 @@ export default class Batch {
 	 * Adds delta to the Batch instance. All modification methods (insert, remove, split, etc.) use this method
 	 * Adds delta to the Batch instance. All modification methods (insert, remove, split, etc.) use this method
 	 * to add created deltas.
 	 * to add created deltas.
 	 *
 	 *
+	 * @fires {@link core.treeModel.Document#batch}
 	 * @param {core.treeModel.delta.Delta} delta Delta to add.
 	 * @param {core.treeModel.delta.Delta} delta Delta to add.
 	 * @return {core.treeModel.delta.Delta} Added delta.
 	 * @return {core.treeModel.delta.Delta} Added delta.
 	 */
 	 */

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

@@ -43,7 +43,7 @@ export default class Delta {
 	 * are no operations in delta, returns `null`.
 	 * are no operations in delta, returns `null`.
 	 *
 	 *
 	 * @see core.treeModel.Document
 	 * @see core.treeModel.Document
-	 * @type {Number|null} Delta base version.
+	 * @type {Number|null}
 	 */
 	 */
 	get baseVersion() {
 	get baseVersion() {
 		if ( this.operations.length > 0 ) {
 		if ( this.operations.length > 0 ) {

+ 8 - 3
packages/ckeditor5-engine/src/treemodel/document.js

@@ -119,8 +119,7 @@ export default class Document {
 	 * {@link core.treeModel.operation.Operation operations}. To create operations in the simple way use the
 	 * {@link core.treeModel.operation.Operation operations}. To create operations in the simple way use the
 	 * {@link core.treeModel.Batch} API available via {@link core.treeModel.Document#batch} method.
 	 * {@link core.treeModel.Batch} API available via {@link core.treeModel.Document#batch} method.
 	 *
 	 *
-	 * This method calls {@link core.treeModel.Document#change} event.
-	 *
+	 * @fires @link core.treeModel.Document#change
 	 * @param {core.treeModel.operation.Operation} operation Operation to be applied.
 	 * @param {core.treeModel.operation.Operation} operation Operation to be applied.
 	 */
 	 */
 	applyOperation( operation ) {
 	applyOperation( operation ) {
@@ -199,7 +198,7 @@ export default class Document {
 	 *
 	 *
 	 * When all queued changes are done {@link core.treeModel.Document#changesDone} event is fired.
 	 * When all queued changes are done {@link core.treeModel.Document#changesDone} event is fired.
 	 *
 	 *
-	 * @fires {@link core.treeModel.Document#changesDone}
+	 * @fires @link core.treeModel.Document#changesDone
 	 * @param {Function} callback Callback to enqueue.
 	 * @param {Function} callback Callback to enqueue.
 	 */
 	 */
 	enqueueChanges( callback ) {
 	enqueueChanges( callback ) {
@@ -320,6 +319,12 @@ export default class Document {
 	 *
 	 *
 	 * @event core.treeModel.Document#changesDone
 	 * @event core.treeModel.Document#changesDone
 	 */
 	 */
+
+	/**
+	 * Fired when a first delta is added to a batch. Can be treated as "new batch created" event.
+	 *
+	 * @event core.treeModel.Document#batch
+	 */
 }
 }
 
 
 utils.mix( Document, EmitterMixin );
 utils.mix( Document, EmitterMixin );