浏览代码

Docs: minor TreeWalker docs updates.

Piotr Jasiun 10 年之前
父节点
当前提交
13a3328031
共有 1 个文件被更改,包括 4 次插入3 次删除
  1. 4 3
      packages/ckeditor5-engine/src/treemodel/treewalker.js

+ 4 - 3
packages/ckeditor5-engine/src/treemodel/treewalker.js

@@ -40,9 +40,9 @@ export default class TreeWalker {
 	 * @param {Object} options Object with configuration.
 	 * @param {treeModel.Range} [options.boundaries] Range to define boundaries of the iterator.
 	 * @param {treeModel.Position} [options.position] Starting position.
-	 * @param {Boolean} [options.mergeCharacters] Flag indicating whether all consecutive characters with the same attributes
+	 * @param {Boolean} [options.mergeCharacters=false] Flag indicating whether all consecutive characters with the same attributes
 	 * should be returned as one {@link treeModel.TextFragment} (`true`) or one by one as multiple {@link treeModel.CharacterProxy}
-	 * (`false`) objects. Defaults to `false`.
+	 * (`false`) objects.
 	 * @constructor
 	 */
 	constructor( options ) {
@@ -84,7 +84,8 @@ export default class TreeWalker {
 		this._boundaryEndParent = this.boundaries ? this.boundaries.end.parent : null;
 
 		/**
-		 * Iterator position.
+		 * Iterator position. This is alway static position, even if the initial position was a
+		 * {@link treeModel.LivePosition live position}.
 		 *
 		 * @property {treeModel.Position} position
 		 */