8
0
Piotrek Koszuliński 5 лет назад
Родитель
Сommit
3aa73c8693

+ 1 - 1
packages/ckeditor5-engine/src/controller/datacontroller.js

@@ -47,7 +47,7 @@ export default class DataController {
 	 * Creates a data controller instance.
 	 *
 	 * @param {module:engine/model/model~Model} model Data model.
-	 * @param {module:engine/view/stylesmap~StylesProcessor} stylesProcessor Styles processor.
+	 * @param {module:engine/view/stylesmap~StylesProcessor} stylesProcessor The styles processor instance..
 	 */
 	constructor( model, stylesProcessor ) {
 		/**

+ 1 - 1
packages/ckeditor5-engine/src/controller/editingcontroller.js

@@ -31,7 +31,7 @@ export default class EditingController {
 	 * Creates an editing controller instance.
 	 *
 	 * @param {module:engine/model/model~Model} model Editing model.
-	 * @param {module:engine/view/stylesmap~StylesProcessor} stylesProcessor Styles processor.
+	 * @param {module:engine/view/stylesmap~StylesProcessor} stylesProcessor The styles processor instance..
 	 */
 	constructor( model, stylesProcessor ) {
 		/**

+ 1 - 1
packages/ckeditor5-engine/src/view/attributeelement.js

@@ -33,7 +33,7 @@ export default class AttributeElement extends Element {
 	 * @see module:engine/view/downcastwriter~DowncastWriter#createAttributeElement
 	 * @see module:engine/view/element~Element
 	 * @protected
-	 * @param {module:engine/view/document~Document} document A document where the element belongs to.
+	 * @param {module:engine/view/document~Document} document The document instance to which this element belongs.
 	 * @param {String} name Node name.
 	 * @param {Object|Iterable} [attrs] Collection of attributes.
 	 * @param {module:engine/view/node~Node|Iterable.<module:engine/view/node~Node>} [children]

+ 1 - 1
packages/ckeditor5-engine/src/view/containerelement.js

@@ -37,7 +37,7 @@ export default class ContainerElement extends Element {
 	 * @see module:engine/view/downcastwriter~DowncastWriter#createContainerElement
 	 * @see module:engine/view/element~Element
 	 * @protected
-	 * @param {module:engine/view/document~Document} document A document where the element belongs to.
+	 * @param {module:engine/view/document~Document} document The document instance to which this element belongs.
 	 * @param {String} name Node name.
 	 * @param {Object|Iterable} [attrs] Collection of attributes.
 	 * @param {module:engine/view/node~Node|Iterable.<module:engine/view/node~Node>} [children]

+ 2 - 2
packages/ckeditor5-engine/src/view/document.js

@@ -24,7 +24,7 @@ export default class Document {
 	/**
 	 * Creates a Document instance.
 	 *
-	 * @param {module:engine/view/stylesmap~StylesProcessor} stylesProcessor Styles processor.
+	 * @param {module:engine/view/stylesmap~StylesProcessor} stylesProcessor The styles processor instance..
 	 */
 	constructor( stylesProcessor ) {
 		/**
@@ -49,7 +49,7 @@ export default class Document {
 		this.roots = new Collection( { idProperty: 'rootName' } );
 
 		/**
-		 * StylesProcessor is responsible for writing and reading a normalized styles object.
+		 * The styles processor instance used by this document when normalizing styles.
 		 *
 		 * @readonly
 		 * @member {module:engine/view/stylesmap~StylesProcessor}

+ 3 - 2
packages/ckeditor5-engine/src/view/documentfragment.js

@@ -25,14 +25,15 @@ export default class DocumentFragment {
 	 * Creates new DocumentFragment instance.
 	 *
 	 * @protected
-	 * @param {module:engine/view/document~Document} document A document where the document fragment belongs to.
+	 * @param {module:engine/view/document~Document} document The document to which this document fragment belongs.
 	 * @param {module:engine/view/node~Node|Iterable.<module:engine/view/node~Node>} [children]
 	 * A list of nodes to be inserted into the created document fragment.
 	 */
 	constructor( document, children ) {
 		/**
-		 * A document where the document fragment belongs to.
+		 * The document to which this document fragment belongs.
 		 *
+		 * @readonly
 		 * @member {module:engine/view/document~Document}
 		 */
 		this.document = document;

+ 1 - 1
packages/ckeditor5-engine/src/view/domconverter.js

@@ -44,7 +44,7 @@ export default class DomConverter {
 	/**
 	 * Creates DOM converter.
 	 *
-	 * @param {module:engine/view/document~Document} document
+	 * @param {module:engine/view/document~Document} document The view document instance.
 	 * @param {Object} options Object with configuration options.
 	 * @param {module:engine/view/filler~BlockFillerMode} [options.blockFillerMode='br'] The type of the block filler to use.
 	 */

+ 5 - 3
packages/ckeditor5-engine/src/view/downcastwriter.js

@@ -38,10 +38,12 @@ import { isPlainObject } from 'lodash-es';
  */
 export default class DowncastWriter {
 	/**
-	 * @param {module:engine/view/document~Document} document
+	 * @param {module:engine/view/document~Document} document The view document instance.
 	 */
 	constructor( document ) {
 		/**
+		 * The view document instance in which this writer operates.
+		 *
 		 * @readonly
 		 * @type {module:engine/view/document~Document}
 		 */
@@ -988,7 +990,7 @@ export default class DowncastWriter {
 	/**
 	 * Creates a range spanning from `start` position to `end` position.
 	 *
-	 * **Note:** This factory method creates it's own {@link module:engine/view/position~Position} instances basing on passed values.
+	 * **Note:** This factory method creates its own {@link module:engine/view/position~Position} instances basing on passed values.
 	 *
 	 * @param {module:engine/view/position~Position} start Start position.
 	 * @param {module:engine/view/position~Position} [end] End position. If not set, range will be collapsed at `start` position.
@@ -1810,7 +1812,7 @@ function breakTextNode( position ) {
 	position.parent._data = position.parent.data.slice( 0, position.offset );
 
 	// Insert new text node after position's parent text node.
-	position.parent.parent._insertChild( position.parent.index + 1, new Text( position.parent.document, textToMove ) );
+	position.parent.parent._insertChild( position.parent.index + 1, new Text( position.root.document, textToMove ) );
 
 	// Return new position between two newly created text nodes.
 	return new Position( position.parent.parent, position.parent.index + 1 );

+ 1 - 1
packages/ckeditor5-engine/src/view/element.js

@@ -53,7 +53,7 @@ export default class Element extends Node {
 	 *		new Element( 'div', mapOfAttributes ); // map
 	 *
 	 * @protected
-	 * @param {module:engine/view/document~Document} document A document where the element belongs to.
+	 * @param {module:engine/view/document~Document} document The document instance to which this element belongs.
 	 * @param {String} name Node name.
 	 * @param {Object|Iterable} [attrs] Collection of attributes.
 	 * @param {module:engine/view/node~Node|Iterable.<module:engine/view/node~Node>} [children]

+ 1 - 1
packages/ckeditor5-engine/src/view/emptyelement.js

@@ -28,7 +28,7 @@ export default class EmptyElement extends Element {
 	 *
 	 * @see module:engine/view/downcastwriter~DowncastWriter#createEmptyElement
 	 * @protected
-	 * @param {module:engine/view/document~Document} document A document where the element belongs to.
+	 * @param {module:engine/view/document~Document} document The document instance to which this element belongs.
 	 * @param {String} name Node name.
 	 * @param {Object|Iterable} [attrs] Collection of attributes.
 	 * @param {module:engine/view/node~Node|Iterable.<module:engine/view/node~Node>} [children]

+ 1 - 0
packages/ckeditor5-engine/src/view/node.js

@@ -35,6 +35,7 @@ export default class Node {
 		/**
 		 * A document where the node belongs to.
 		 *
+		 * @readonly
 		 * @member {module:engine/view/document~Document}
 		 */
 		this.document = document;

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

@@ -22,7 +22,7 @@ export default class RootEditableElement extends EditableElement {
 	/**
 	 * Creates root editable element.
 	 *
-	 * @param {module:engine/view/document~Document} document A document where the element belongs to.
+	 * @param {module:engine/view/document~Document} document The document instance to which this element belongs.
 	 * @param {String} name Node name.
 	 */
 	constructor( document, name ) {

+ 1 - 1
packages/ckeditor5-engine/src/view/uielement.js

@@ -41,7 +41,7 @@ export default class UIElement extends Element {
 	 *
 	 * @see module:engine/view/downcastwriter~DowncastWriter#createUIElement
 	 * @protected
-	 * @param {module:engine/view/document~Document} document A document where the element belongs to.
+	 * @param {module:engine/view/document~Document} document The document instance to which this element belongs.
 	 * @param {String} name Node name.
 	 * @param {Object|Iterable} [attributes] Collection of attributes.
 	 * @param {module:engine/view/node~Node|Iterable.<module:engine/view/node~Node>} [children]

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

@@ -63,7 +63,7 @@ import env from '@ckeditor/ckeditor5-utils/src/env';
  */
 export default class View {
 	/**
-	 * @param {module:engine/view/stylesmap~StylesProcessor} stylesProcessor Styles processor.
+	 * @param {module:engine/view/stylesmap~StylesProcessor} stylesProcessor The styles processor instance..
 	 */
 	constructor( stylesProcessor ) {
 		/**