Browse Source

Docs fixes.

Piotr Jasiun 9 years ago
parent
commit
d029336578

+ 2 - 2
packages/ckeditor5-engine/src/model/rootelement.js

@@ -25,8 +25,8 @@ export default class RootElement extends Element {
 		/**
 		 * Document that is an owner of this root.
 		 *
-		 * @readonly
-		 * @member {engine.model.Document} engine.model.RootElement#document
+		 * @private
+		 * @member {engine.model.Document} engine.model.RootElement#_doc
 		 */
 		this._doc = doc;
 

+ 1 - 1
packages/ckeditor5-engine/src/model/text.js

@@ -8,7 +8,7 @@ import Node from './node.js';
 /**
  * Model text node. Type of {@link engine.model.Node node} that contains {@link engine.model.Text#data text data}.
  *
- * **Important:** see {@link engine.model.Node} to read about restrictions using `Element` and `Node` API.
+ * **Important:** see {@link engine.model.Node} to read about restrictions using `Text` and `Node` API.
  *
  * **Note:** keep in mind that `Text` instances might indirectly got removed from model tree when model is changed.
  * This happens when {@link engine.model.writer model writer} is used to change model and the text node is merged with

+ 1 - 1
packages/ckeditor5-engine/src/model/textproxy.js

@@ -24,7 +24,7 @@
  *
  * **Note:** `TextProxy` instances are created on the fly, basing on the current state of model. Because of this, it is
  * highly unrecommended to store references to `TextProxy` instances. `TextProxy` instances are not refreshed when
- * model changes, so they might get invalidated.
+ * model changes, so they might get invalidated. Instead, consider creating {@link engine.model.LivePosition live position}.
  *
  * `TextProxy` instances are created by {@link engine.model.TreeWalker model tree walker}. You should not need to create
  * an instance of this class by your own.