Piotrek Koszuliński преди 9 години
родител
ревизия
c83929506d

+ 2 - 1
packages/ckeditor5-engine/src/view/editableelement.js

@@ -11,7 +11,7 @@ import mix from '../../utils/mix.js';
 import ObservableMixin from '../../utils/observablemixin.js';
 
 /**
- * Editable element which be a {@link view.engine.RootEditableElement root} or nested editable area in the editor.
+ * Editable element which can be a {@link view.engine.RootEditableElement root} or nested editable area in the editor.
  *
  * @memberOf engine.view
  * @extends engine.view.ContainerElement
@@ -23,6 +23,7 @@ export default class EditableElement extends ContainerElement {
 	 */
 	constructor( name, attrs, children ) {
 		super( name, attrs, children );
+
 		/**
 		 * Whether the editable is in read-write or read-only mode.
 		 *

+ 3 - 3
packages/ckeditor5-engine/src/view/node.js

@@ -167,7 +167,7 @@ export default class Node {
 	/**
 	 * Fired when list of {@link engine.view.Element elements} children changes.
 	 *
-	 * Change event is bubbling, it is fired on the ancestors chain.
+	 * Change event is bubbled – it is fired on all ancestors.
 	 *
 	 * @event engine.view.Node#change:children
 	 * @param {engine.view.Node} Changed node.
@@ -176,7 +176,7 @@ export default class Node {
 	/**
 	 * Fired when list of {@link engine.view.Element elements} attributes changes.
 	 *
-	 * Change event is bubbling, it is fired on the ancestors chain.
+	 * Change event is bubbled – it is fired on all ancestors.
 	 *
 	 * @event engine.view.Node#change:attributes
 	 * @param {engine.view.Node} Changed node.
@@ -185,7 +185,7 @@ export default class Node {
 	/**
 	 * Fired when {@link engine.view.Text text nodes} data changes.
 	 *
-	 * Change event is bubbling, it is fired on the ancestors chain.
+	 * Change event is bubbled – it is fired on all ancestors.
 	 *
 	 * @event engine.view.Node#change:text
 	 * @param {engine.view.Node} Changed node.

+ 5 - 4
packages/ckeditor5-engine/src/view/rooteditableelement.js

@@ -8,8 +8,9 @@
 import EditableElement from './editableelement.js';
 
 /**
- * Roots of nodes trees in data view. They are editable element binded to editable DOM element, which are the base for
- * the editable areas.
+ * Class representing a single root in the data view. A root can be either {@link #isReadOnly editable or read-only}, but
+ * in both cases it is called "an editable". Roots can contain other {@link engine.view.EditableElement editable elements}
+ * making them "nested editables".
  *
  * @memberOf engine.view
  * @extends engine.view.EditableElement
@@ -55,9 +56,9 @@ export default class RootEditableElement extends EditableElement {
 	}
 
 	/**
-	 * Gets {@link engine.view.Document} reference.
+	 * Gets the {@link engine.view.Document} reference.
 	 *
-	 * @returns {engine.view.Document|null} View Document of the node or null.
+	 * @returns {engine.view.Document|null} View Document of the node or `null`.
 	 */
 	getDocument() {
 		return this._document;