소스 검색

Docs update.

Piotr Jasiun 9 년 전
부모
커밋
c80f72f3d4

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

@@ -8,20 +8,20 @@
 import Element from './element.js';
 
 /**
- * Class for nodes that are roots of trees in tree data model.
+ * Class for nodes that are roots of trees in data model.
  *
  * @memberOf engine.model
  * @extends engine.model.Element
  */
 export default class RootElement extends Element {
 	/**
-	 * Creates tree root node.
+	 * Creates root element.
 	 *
 	 * @param {engine.model.Document} doc {@link engine.model.Document} that is an owner of the root.
 	 * @param {String} name Node name.
-	 * @param {String} rootName Root name inside parent {@link engine.model.Document}.
+	 * @param {String} [rootName='main'] Root name inside parent {@link engine.model.Document}.
 	 */
-	constructor( doc, name, rootName ) {
+	constructor( doc, name, rootName = 'main' ) {
 		super( name );
 
 		/**

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

@@ -10,6 +10,13 @@ import ContainerElement from './containerelement.js';
 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.
+ *
+ * @memberOf engine.view
+ * @extends engine.view.ContainerElement
+ * @mixes utils.ObservaleMixin
+ */
 export default class EditableElement extends ContainerElement {
 	/**
 	 * Creates an editable element.
@@ -20,7 +27,7 @@ export default class EditableElement extends ContainerElement {
 		 * Whether the editable is in read-write or read-only mode.
 		 *
 		 * @observable
-		 * @member {Boolean} engine.view.EditableElement#isEditable
+		 * @member {Boolean} engine.view.EditableElement#isReadOnly
 		 */
 		this.set( 'isReadOnly', false );
 	}

+ 12 - 1
packages/ckeditor5-engine/src/view/rooteditableelement.js

@@ -7,9 +7,20 @@
 
 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.
+ *
+ * @memberOf engine.view
+ * @extends engine.view.EditableElement
+ */
 export default class RootEditableElement extends EditableElement {
 	/**
-	 * Creates an root editable element.
+	 * Creates root editable element.
+	 *
+	 * @param {engine.view.Document} document {@link engine.view.Document} that is an owner of the root.
+	 * @param {String} name Node name.
+	 * @param {String} [rootName='main'] Root name inside parent {@link engine.view.Document}.
 	 */
 	constructor( document, name, rootName = 'main' ) {
 		super( name );