@ckeditor/ckeditor5-engine 36.0.1 → 37.0.0-alpha.0

package/src/dev-utils/view.js

@@ -44,26 +44,24 @@ const domConverterStub = {
 /**
  * Writes the content of the {@link module:engine/view/document~Document document} to an HTML-like string.
  *
- * @param {module:engine/view/view~View} view
- * @param {Object} [options]
- * @param {Boolean} [options.withoutSelection=false] Whether to write the selection. When set to `true`, the selection will
+ * @param options.withoutSelection Whether to write the selection. When set to `true`, the selection will
  * not be included in the returned string.
- * @param {Boolean} [options.rootName='main'] The name of the root from which the data should be stringified. If not provided,
+ * @param options.rootName The name of the root from which the data should be stringified. If not provided,
  * the default `main` name will be used.
- * @param {Boolean} [options.showType=false] When set to `true`, the type of elements will be printed (`<container:p>`
+ * @param options.showType When set to `true`, the type of elements will be printed (`<container:p>`
  * instead of `<p>`, `<attribute:b>` instead of `<b>` and `<empty:img>` instead of `<img>`).
- * @param {Boolean} [options.showPriority=false] When set to `true`, the attribute element's priority will be printed
+ * @param options.showPriority When set to `true`, the attribute element's priority will be printed
  * (`<span view-priority="12">`, `<b view-priority="10">`).
- * @param {Boolean} [options.showAttributeElementId=false] When set to `true`, the attribute element's ID will be printed
+ * @param options.showAttributeElementId When set to `true`, the attribute element's ID will be printed
  * (`<span id="marker:foo">`).
- * @param {Boolean} [options.renderUIElements=false] When set to `true`, the inner content of each
+ * @param options.renderUIElements When set to `true`, the inner content of each
  * {@link module:engine/view/uielement~UIElement} will be printed.
- * @param {Boolean} [options.renderRawElements=false] When set to `true`, the inner content of each
+ * @param options.renderRawElements When set to `true`, the inner content of each
  * {@link module:engine/view/rawelement~RawElement} will be printed.
- * @param {Object} [options.domConverter=null] When set to an actual {@link module:engine/view/domconverter~DomConverter DomConverter}
+ * @param options.domConverter When set to an actual {@link module:engine/view/domconverter~DomConverter DomConverter}
  * instance, it lets the conversion go through exactly the same flow the editing view is going through,
  * i.e. with view data filtering. Otherwise the simple stub is used.
- * @returns {String} The stringified data.
+ * @returns The stringified data.
  */
 export function getData(view, options = {}) {
     if (!(view instanceof View)) {
@@ -90,10 +88,8 @@ getData._stringify = stringify;
 /**
  * Sets the content of a view {@link module:engine/view/document~Document document} provided as an HTML-like string.
  *
- * @param {module:engine/view/view~View} view
- * @param {String} data An HTML-like string to write into the document.
- * @param {Object} options
- * @param {String} [options.rootName='main'] The root name where parsed data will be stored. If not provided,
+ * @param data An HTML-like string to write into the document.
+ * @param options.rootName The root name where parsed data will be stored. If not provided,
  * the default `main` name will be used.
  */
 export function setData(view, data, options = {}) {
@@ -117,46 +113,56 @@ setData._parse = parse;
  *
  * A root element can be provided as {@link module:engine/view/text~Text text}:
  *
- *		const text = downcastWriter.createText( 'foobar' );
- *		stringify( text ); // 'foobar'
+ * ```ts
+ * const text = downcastWriter.createText( 'foobar' );
+ * stringify( text ); // 'foobar'
+ * ```
  *
  * or as an {@link module:engine/view/element~Element element}:
  *
- *		const element = downcastWriter.createElement( 'p', null, downcastWriter.createText( 'foobar' ) );
- *		stringify( element ); // '<p>foobar</p>'
+ * ```ts
+ * const element = downcastWriter.createElement( 'p', null, downcastWriter.createText( 'foobar' ) );
+ * stringify( element ); // '<p>foobar</p>'
+ * ```
  *
  * or as a {@link module:engine/view/documentfragment~DocumentFragment document fragment}:
  *
- *		const text = downcastWriter.createText( 'foobar' );
- *		const b = downcastWriter.createElement( 'b', { name: 'test' }, text );
- *		const p = downcastWriter.createElement( 'p', { style: 'color:red;' } );
- *		const fragment = downcastWriter.createDocumentFragment( [ p, b ] );
+ * ```ts
+ * const text = downcastWriter.createText( 'foobar' );
+ * const b = downcastWriter.createElement( 'b', { name: 'test' }, text );
+ * const p = downcastWriter.createElement( 'p', { style: 'color:red;' } );
+ * const fragment = downcastWriter.createDocumentFragment( [ p, b ] );
  *
- *		stringify( fragment ); // '<p style="color:red;"></p><b name="test">foobar</b>'
+ * stringify( fragment ); // '<p style="color:red;"></p><b name="test">foobar</b>'
+ * ```
  *
  * Additionally, a {@link module:engine/view/documentselection~DocumentSelection selection} instance can be provided.
  * Ranges from the selection will then be included in the output data.
  * If a range position is placed inside the element node, it will be represented with `[` and `]`:
  *
- *		const text = downcastWriter.createText( 'foobar' );
- *		const b = downcastWriter.createElement( 'b', null, text );
- *		const p = downcastWriter.createElement( 'p', null, b );
- *		const selection = downcastWriter.createSelection(
- *			downcastWriter.createRangeIn( p )
- *		);
+ * ```ts
+ * const text = downcastWriter.createText( 'foobar' );
+ * const b = downcastWriter.createElement( 'b', null, text );
+ * const p = downcastWriter.createElement( 'p', null, b );
+ * const selection = downcastWriter.createSelection(
+ * 	downcastWriter.createRangeIn( p )
+ * );
  *
- *		stringify( p, selection ); // '<p>[<b>foobar</b>]</p>'
+ * stringify( p, selection ); // '<p>[<b>foobar</b>]</p>'
+ * ```
  *
  * If a range is placed inside the text node, it will be represented with `{` and `}`:
  *
- *		const text = downcastWriter.createText( 'foobar' );
- *		const b = downcastWriter.createElement( 'b', null, text );
- *		const p = downcastWriter.createElement( 'p', null, b );
- *		const selection = downcastWriter.createSelection(
- *			downcastWriter.createRange( downcastWriter.createPositionAt( text, 1 ), downcastWriter.createPositionAt( text, 5 ) )
- *		);
+ * ```ts
+ * const text = downcastWriter.createText( 'foobar' );
+ * const b = downcastWriter.createElement( 'b', null, text );
+ * const p = downcastWriter.createElement( 'p', null, b );
+ * const selection = downcastWriter.createSelection(
+ * 	downcastWriter.createRange( downcastWriter.createPositionAt( text, 1 ), downcastWriter.createPositionAt( text, 5 ) )
+ * );
  *
- *		stringify( p, selection ); // '<p><b>f{ooba}r</b></p>'
+ * stringify( p, selection ); // '<p><b>f{ooba}r</b></p>'
+ * ```
  *
  * ** Note: **
  * It is possible to unify selection markers to `[` and `]` for both (inside and outside text)
@@ -165,25 +171,29 @@ setData._parse = parse;
  *
  * Multiple ranges are supported:
  *
- *		const text = downcastWriter.createText( 'foobar' );
- *		const selection = downcastWriter.createSelection( [
- *			downcastWriter.createRange( downcastWriter.createPositionAt( text, 0 ), downcastWriter.createPositionAt( text, 1 ) ),
- *			downcastWriter.createRange( downcastWriter.createPositionAt( text, 3 ), downcastWriter.createPositionAt( text, 5 ) )
- *		] );
+ * ```ts
+ * const text = downcastWriter.createText( 'foobar' );
+ * const selection = downcastWriter.createSelection( [
+ * 	downcastWriter.createRange( downcastWriter.createPositionAt( text, 0 ), downcastWriter.createPositionAt( text, 1 ) ),
+ * 	downcastWriter.createRange( downcastWriter.createPositionAt( text, 3 ), downcastWriter.createPositionAt( text, 5 ) )
+ * ] );
  *
- *		stringify( text, selection ); // '{f}oo{ba}r'
+ * stringify( text, selection ); // '{f}oo{ba}r'
+ * ```
  *
  * A {@link module:engine/view/range~Range range} or {@link module:engine/view/position~Position position} instance can be provided
  * instead of the {@link module:engine/view/documentselection~DocumentSelection selection} instance. If a range instance
  * is provided, it will be converted to a selection containing this range. If a position instance is provided, it will
  * be converted to a selection containing one range collapsed at this position.
  *
- *		const text = downcastWriter.createText( 'foobar' );
- *		const range = downcastWriter.createRange( downcastWriter.createPositionAt( text, 0 ), downcastWriter.createPositionAt( text, 1 ) );
- *		const position = downcastWriter.createPositionAt( text, 3 );
+ * ```ts
+ * const text = downcastWriter.createText( 'foobar' );
+ * const range = downcastWriter.createRange( downcastWriter.createPositionAt( text, 0 ), downcastWriter.createPositionAt( text, 1 ) );
+ * const position = downcastWriter.createPositionAt( text, 3 );
  *
- *		stringify( text, range ); // '{f}oobar'
- *		stringify( text, position ); // 'foo{}bar'
+ * stringify( text, range ); // '{f}oobar'
+ * stringify( text, position ); // 'foo{}bar'
+ * ```
  *
  * An additional `options` object can be provided.
  * If `options.showType` is set to `true`, element's types will be
@@ -192,55 +202,58 @@ setData._parse = parse;
  * {@link module:engine/view/emptyelement~EmptyElement empty elements}
  * and {@link module:engine/view/uielement~UIElement UI elements}:
  *
- *		const attribute = downcastWriter.createAttributeElement( 'b' );
- *		const container = downcastWriter.createContainerElement( 'p' );
- *		const empty = downcastWriter.createEmptyElement( 'img' );
- *		const ui = downcastWriter.createUIElement( 'span' );
- *		getData( attribute, null, { showType: true } ); // '<attribute:b></attribute:b>'
- *		getData( container, null, { showType: true } ); // '<container:p></container:p>'
- *		getData( empty, null, { showType: true } ); // '<empty:img></empty:img>'
- *		getData( ui, null, { showType: true } ); // '<ui:span></ui:span>'
+ * ```ts
+ * const attribute = downcastWriter.createAttributeElement( 'b' );
+ * const container = downcastWriter.createContainerElement( 'p' );
+ * const empty = downcastWriter.createEmptyElement( 'img' );
+ * const ui = downcastWriter.createUIElement( 'span' );
+ * getData( attribute, null, { showType: true } ); // '<attribute:b></attribute:b>'
+ * getData( container, null, { showType: true } ); // '<container:p></container:p>'
+ * getData( empty, null, { showType: true } ); // '<empty:img></empty:img>'
+ * getData( ui, null, { showType: true } ); // '<ui:span></ui:span>'
+ * ```
  *
  * If `options.showPriority` is set to `true`, a priority will be displayed for all
  * {@link module:engine/view/attributeelement~AttributeElement attribute elements}.
  *
- *		const attribute = downcastWriter.createAttributeElement( 'b' );
- *		attribute._priority = 20;
- *		getData( attribute, null, { showPriority: true } ); // <b view-priority="20"></b>
+ * ```ts
+ * const attribute = downcastWriter.createAttributeElement( 'b' );
+ * attribute._priority = 20;
+ * getData( attribute, null, { showPriority: true } ); // <b view-priority="20"></b>
+ * ```
  *
  * If `options.showAttributeElementId` is set to `true`, the attribute element's id will be displayed for all
  * {@link module:engine/view/attributeelement~AttributeElement attribute elements} that have it set.
  *
- *		const attribute = downcastWriter.createAttributeElement( 'span' );
- *		attribute._id = 'marker:foo';
- *		getData( attribute, null, { showAttributeElementId: true } ); // <span view-id="marker:foo"></span>
- *
- * @param {module:engine/view/text~Text|module:engine/view/element~Element|module:engine/view/documentfragment~DocumentFragment}
- * node The node to stringify.
- * @param {module:engine/view/documentselection~DocumentSelection|module:engine/view/position~Position|module:engine/view/range~Range}
- * [selectionOrPositionOrRange = null ]
- * A selection instance whose ranges will be included in the returned string data. If a range instance is provided, it will be
- * converted to a selection containing this range. If a position instance is provided, it will be converted to a selection
- * containing one range collapsed at this position.
- * @param {Object} [options] An object with additional options.
- * @param {Boolean} [options.showType=false] When set to `true`, the type of elements will be printed (`<container:p>`
+ * ```ts
+ * const attribute = downcastWriter.createAttributeElement( 'span' );
+ * attribute._id = 'marker:foo';
+ * getData( attribute, null, { showAttributeElementId: true } ); // <span view-id="marker:foo"></span>
+ * ```
+ *
+ * @param node The node to stringify.
+ * @param selectionOrPositionOrRange A selection instance whose ranges will be included in the returned string data.
+ * If a range instance is provided, it will be converted to a selection containing this range. If a position instance
+ * is provided, it will be converted to a selection containing one range collapsed at this position.
+ * @param options An object with additional options.
+ * @param options.showType When set to `true`, the type of elements will be printed (`<container:p>`
  * instead of `<p>`, `<attribute:b>` instead of `<b>` and `<empty:img>` instead of `<img>`).
- * @param {Boolean} [options.showPriority=false] When set to `true`,  the attribute element's priority will be printed
+ * @param options.showPriority When set to `true`,  the attribute element's priority will be printed
  * (`<span view-priority="12">`, `<b view-priority="10">`).
- * @param {Boolean} [options.showAttributeElementId=false] When set to `true`, attribute element's id will be printed
+ * @param options.showAttributeElementId When set to `true`, attribute element's id will be printed
  * (`<span id="marker:foo">`).
- * @param {Boolean} [options.ignoreRoot=false] When set to `true`, the root's element opening and closing will not be printed.
+ * @param options.ignoreRoot When set to `true`, the root's element opening and closing will not be printed.
  * Mainly used by the `getData` function to ignore the {@link module:engine/view/document~Document document's} root element.
- * @param {Boolean} [options.sameSelectionCharacters=false] When set to `true`, the selection inside the text will be marked as
+ * @param options.sameSelectionCharacters When set to `true`, the selection inside the text will be marked as
  *  `{` and `}` and the selection outside the text as `[` and `]`. When set to `false`, both will be marked as `[` and `]` only.
- * @param {Boolean} [options.renderUIElements=false] When set to `true`, the inner content of each
+ * @param options.renderUIElements When set to `true`, the inner content of each
  * {@link module:engine/view/uielement~UIElement} will be printed.
- * @param {Boolean} [options.renderRawElements=false] When set to `true`, the inner content of each
+ * @param options.renderRawElements When set to `true`, the inner content of each
  * {@link module:engine/view/rawelement~RawElement} will be printed.
- * @param {Object} [options.domConverter={}] When set to an actual {@link module:engine/view/domconverter~DomConverter DomConverter}
+ * @param options.domConverter When set to an actual {@link module:engine/view/domconverter~DomConverter DomConverter}
  * instance, it lets the conversion go through exactly the same flow the editing view is going through,
  * i.e. with view data filtering. Otherwise the simple stub is used.
- * @returns {String} An HTML-like string representing the view.
+ * @returns An HTML-like string representing the view.
  */
 export function stringify(node, selectionOrPositionOrRange = null, options = {}) {
     let selection;
@@ -258,26 +271,36 @@ export function stringify(node, selectionOrPositionOrRange = null, options = {})
  * Parses an HTML-like string and returns a view tree.
  * A simple string will be converted to a {@link module:engine/view/text~Text text} node:
  *
- *		parse( 'foobar' ); // Returns an instance of text.
+ * ```ts
+ * parse( 'foobar' ); // Returns an instance of text.
+ * ```
  *
  * {@link module:engine/view/element~Element Elements} will be parsed with attributes as children:
  *
- *		parse( '<b name="baz">foobar</b>' ); // Returns an instance of element with the `baz` attribute and a text child node.
+ * ```ts
+ * parse( '<b name="baz">foobar</b>' ); // Returns an instance of element with the `baz` attribute and a text child node.
+ * ```
  *
  * Multiple nodes provided on root level will be converted to a
  * {@link module:engine/view/documentfragment~DocumentFragment document fragment}:
  *
- *		parse( '<b>foo</b><i>bar</i>' ); // Returns a document fragment with two child elements.
+ * ```ts
+ * parse( '<b>foo</b><i>bar</i>' ); // Returns a document fragment with two child elements.
+ * ```
  *
  * The method can parse multiple {@link module:engine/view/range~Range ranges} provided in string data and return a
  * {@link module:engine/view/documentselection~DocumentSelection selection} instance containing these ranges. Ranges placed inside
  * {@link module:engine/view/text~Text text} nodes should be marked using `{` and `}` brackets:
  *
- *		const { text, selection } = parse( 'f{ooba}r' );
+ * ```ts
+ * const { text, selection } = parse( 'f{ooba}r' );
+ * ```
  *
  * Ranges placed outside text nodes should be marked using `[` and `]` brackets:
  *
- *		const { root, selection } = parse( '<p>[<b>foobar</b>]</p>' );
+ * ```ts
+ * const { root, selection } = parse( '<p>[<b>foobar</b>]</p>' );
+ * ```
  *
  * ** Note: **
  * It is possible to unify selection markers to `[` and `]` for both (inside and outside text)
@@ -286,7 +309,9 @@ export function stringify(node, selectionOrPositionOrRange = null, options = {})
  * Sometimes there is a need for defining the order of ranges inside the created selection. This can be achieved by providing
  * the range order array as an additional parameter:
  *
- *		const { root, selection } = parse( '{fo}ob{ar}{ba}z', { order: [ 2, 3, 1 ] } );
+ * ```ts
+ * const { root, selection } = parse( '{fo}ob{ar}{ba}z', { order: [ 2, 3, 1 ] } );
+ * ```
  *
  * In the example above, the first range (`{fo}`) will be added to the selection as the second one, the second range (`{ar}`) will be
  * added as the third and the third range (`{ba}`) will be added as the first one.
@@ -296,38 +321,39 @@ export function stringify(node, selectionOrPositionOrRange = null, options = {})
  * by the `end` position and {@link module:engine/view/documentselection~DocumentSelection#focus selection focus} is
  * represented by the `start` position), use the `lastRangeBackward` flag:
  *
- *		const { root, selection } = parse( `{foo}bar{baz}`, { lastRangeBackward: true } );
+ * ```ts
+ * const { root, selection } = parse( `{foo}bar{baz}`, { lastRangeBackward: true } );
+ * ```
  *
  * Some more examples and edge cases:
  *
- *		// Returns an empty document fragment.
- *		parse( '' );
+ * ```ts
+ * // Returns an empty document fragment.
+ * parse( '' );
  *
- *		// Returns an empty document fragment and a collapsed selection.
- *		const { root, selection } = parse( '[]' );
+ * // Returns an empty document fragment and a collapsed selection.
+ * const { root, selection } = parse( '[]' );
  *
- *		// Returns an element and a selection that is placed inside the document fragment containing that element.
- *		const { root, selection } = parse( '[<a></a>]' );
+ * // Returns an element and a selection that is placed inside the document fragment containing that element.
+ * const { root, selection } = parse( '[<a></a>]' );
+ * ```
  *
- * @param {String} data An HTML-like string to be parsed.
- * @param {Object} options
- * @param {Array.<Number>} [options.order] An array with the order of parsed ranges added to the returned
+ * @param data An HTML-like string to be parsed.
+ * @param options.order An array with the order of parsed ranges added to the returned
  * {@link module:engine/view/documentselection~DocumentSelection Selection} instance. Each element should represent the
  * desired position of each range in the selection instance. For example: `[2, 3, 1]` means that the first range will be
  * placed as the second, the second as the third and the third as the first.
- * @param {Boolean} [options.lastRangeBackward=false] If set to `true`, the last range will be added as backward to the returned
+ * @param options.lastRangeBackward If set to `true`, the last range will be added as backward to the returned
  * {@link module:engine/view/documentselection~DocumentSelection selection} instance.
- * @param {module:engine/view/element~Element|module:engine/view/documentfragment~DocumentFragment}
- * [options.rootElement=null] The default root to use when parsing elements.
+ * @param options.rootElement The default root to use when parsing elements.
  * When set to `null`, the root element will be created automatically. If set to
  * {@link module:engine/view/element~Element Element} or {@link module:engine/view/documentfragment~DocumentFragment DocumentFragment},
  * this node will be used as the root for all parsed nodes.
- * @param {Boolean} [options.sameSelectionCharacters=false] When set to `false`, the selection inside the text should be marked using
+ * @param options.sameSelectionCharacters When set to `false`, the selection inside the text should be marked using
  * `{` and `}` and the selection outside the ext using `[` and `]`. When set to `true`, both should be marked with `[` and `]` only.
- * @param {module:engine/view/stylesmap~StylesProcessor} [options.stylesProcessor] Styles processor.
- * @returns {module:engine/view/text~Text|module:engine/view/element~Element|module:engine/view/documentfragment~DocumentFragment|Object}
- * Returns the parsed view node or an object with two fields: `view` and `selection` when selection ranges were included in the data
- * to parse.
+ * @param options.stylesProcessor Styles processor.
+ * @returns Returns the parsed view node or an object with two fields: `view` and `selection` when selection ranges were included in the
+ * data to parse.
  */
 export function parse(data, options = {}) {
     const viewDocument = new ViewDocument(new StylesProcessor());
@@ -373,15 +399,13 @@ export function parse(data, options = {}) {
 }
 /**
  * Private helper class used for converting ranges represented as text inside view {@link module:engine/view/text~Text text nodes}.
- *
- * @private
  */
 class RangeParser {
     /**
      * Creates a range parser instance.
      *
-     * @param {Object} options The range parser configuration.
-     * @param {Boolean} [options.sameSelectionCharacters=false] When set to `true`, the selection inside the text is marked as
+     * @param options The range parser configuration.
+     * @param options.sameSelectionCharacters When set to `true`, the selection inside the text is marked as
      * `{` and `}` and the selection outside the text as `[` and `]`. When set to `false`, both are marked as `[` and `]`.
      */
     constructor(options) {
@@ -392,11 +416,11 @@ class RangeParser {
      * The method will remove all occurrences of `{`, `}`, `[` and `]` from found text nodes. If a text node is empty after
      * the process, it will be removed, too.
      *
-     * @param {module:engine/view/node~Node} node The starting node.
-     * @param {Array.<Number>} order The order of ranges. Each element should represent the desired position of the range after
+     * @param node The starting node.
+     * @param order The order of ranges. Each element should represent the desired position of the range after
      * sorting. For example: `[2, 3, 1]` means that the first range will be placed as the second, the second as the third and the third
      * as the first.
-     * @returns {Array.<module:engine/view/range~Range>} An array with ranges found.
+     * @returns An array with ranges found.
      */
     parse(node, order) {
         this._positions = [];
@@ -417,8 +441,7 @@ class RangeParser {
      * Gathers positions of brackets inside the view tree starting from the provided node. The method will remove all occurrences of
      * `{`, `}`, `[` and `]` from found text nodes. If a text node is empty after the process, it will be removed, too.
      *
-     * @private
-     * @param {module:engine/view/node~Node} node Staring node.
+     * @param node Staring node.
      */
     _getPositions(node) {
         if (node.is('documentFragment') || node.is('element')) {
@@ -500,10 +523,9 @@ class RangeParser {
      * For example: `[2, 3, 1]` means that the first range will be placed as the second, the second as the third and the third
      * as the first.
      *
-     * @private
-     * @param {Array.<module:engine/view/range~Range>} ranges Ranges to sort.
-     * @param {Array.<Number>} rangesOrder An array with new range order.
-     * @returns {Array} Sorted ranges array.
+     * @param ranges Ranges to sort.
+     * @param rangesOrder An array with new range order.
+     * @returns Sorted ranges array.
      */
     _sortRanges(ranges, rangesOrder) {
         const sortedRanges = [];
@@ -519,9 +541,6 @@ class RangeParser {
     }
     /**
      * Uses all found bracket positions to create ranges from them.
-     *
-     * @private
-     * @returns {Array.<module:engine/view/range~Range>}
      */
     _createRanges() {
         const ranges = [];
@@ -554,28 +573,24 @@ class RangeParser {
 }
 /**
  * Private helper class used for converting the view tree to a string.
- *
- * @private
  */
 class ViewStringify {
     /**
      * Creates a view stringify instance.
      *
-     * @param root
-     * @param {module:engine/view/documentselection~DocumentSelection} selection A selection whose ranges
-     * should also be converted to a string.
-     * @param {Object} options An options object.
-     * @param {Boolean} [options.showType=false] When set to `true`, the type of elements will be printed (`<container:p>`
+     * @param selection A selection whose ranges should also be converted to a string.
+     * @param options An options object.
+     * @param options.showType When set to `true`, the type of elements will be printed (`<container:p>`
      * instead of `<p>`, `<attribute:b>` instead of `<b>` and `<empty:img>` instead of `<img>`).
-     * @param {Boolean} [options.showPriority=false] When set to `true`, the attribute element's priority will be printed.
-     * @param {Boolean} [options.ignoreRoot=false] When set to `true`, the root's element opening and closing tag will not
+     * @param options.showPriority When set to `true`, the attribute element's priority will be printed.
+     * @param options.ignoreRoot When set to `true`, the root's element opening and closing tag will not
      * be outputted.
-     * @param {Boolean} [options.sameSelectionCharacters=false] When set to `true`, the selection inside the text is marked as
+     * @param options.sameSelectionCharacters When set to `true`, the selection inside the text is marked as
      * `{` and `}` and the selection outside the text as `[` and `]`. When set to `false`, both are marked as `[` and `]`.
-     * @param {Boolean} [options.renderUIElements=false] When set to `true`, the inner content of each
+     * @param options.renderUIElements When set to `true`, the inner content of each
      * {@link module:engine/view/uielement~UIElement} will be printed.
-     * @param {Boolean} [options.renderRawElements=false] When set to `true`, the inner content of each
-     * @param {Object} [options.domConverter={}] When set to an actual {@link module:engine/view/domconverter~DomConverter DomConverter}
+     * @param options.renderRawElements When set to `true`, the inner content of each
+     * @param options.domConverter When set to an actual {@link module:engine/view/domconverter~DomConverter DomConverter}
      * instance, it lets the conversion go through exactly the same flow the editing view is going through,
      * i.e. with view data filtering. Otherwise the simple stub is used.
      * {@link module:engine/view/rawelement~RawElement} will be printed.
@@ -599,7 +614,7 @@ class ViewStringify {
     /**
      * Converts the view to a string.
      *
-     * @returns {String} String representation of the view elements.
+     * @returns String representation of the view elements.
      */
     stringify() {
         let result = '';
@@ -611,10 +626,6 @@ class ViewStringify {
     /**
      * Executes a simple walker that iterates over all elements in the view tree starting from the root element.
      * Calls the `callback` with parsed chunks of string data.
-     *
-     * @private
-     * @param {module:engine/view/documentfragment~DocumentFragment|module:engine/view/element~Element|module:engine/view/text~Text} root
-     * @param {Function} callback
      */
     _walkView(root, callback) {
         const ignore = this.ignoreRoot && this.root === root;
@@ -652,10 +663,6 @@ class ViewStringify {
     /**
      * Checks if a given {@link module:engine/view/element~Element element} has a {@link module:engine/view/range~Range#start range start}
      * or a {@link module:engine/view/range~Range#start range end} placed at a given offset and returns its string representation.
-     *
-     * @private
-     * @param {module:engine/view/element~Element} element
-     * @param {Number} offset
      */
     _stringifyElementRanges(element, offset) {
         let start = '';
@@ -681,9 +688,6 @@ class ViewStringify {
      * {@link module:engine/view/range~Range#start range start} or a
      * {@link module:engine/view/range~Range#start range end} placed somewhere inside. Returns a string representation of text
      * with range delimiters placed inside.
-     *
-     * @private
-     * @param {module:engine/view/text~Text} node
      */
     _stringifyTextRanges(node) {
         const length = node.data.length;
@@ -732,10 +736,6 @@ class ViewStringify {
      * `<attribute:a>` or `<empty:img>`), contain priority information ( `<attribute:a view-priority="20">` ),
      * or contain element id ( `<attribute:span view-id="foo">` ). Element attributes will also be included
      * (`<a href="https://ckeditor.com" name="foobar">`).
-     *
-     * @private
-     * @param {module:engine/view/element~Element} element
-     * @returns {String}
      */
     _stringifyElementOpen(element) {
         const priority = this._stringifyElementPriority(element);
@@ -750,10 +750,6 @@ class ViewStringify {
      * Converts the passed {@link module:engine/view/element~Element element} to a closing tag.
      * Depending on the current configuration, the closing tag can be simple (`</a>`) or contain a type prefix (`</container:p>`,
      * `</attribute:a>` or `</empty:img>`).
-     *
-     * @private
-     * @param {module:engine/view/element~Element} element
-     * @returns {String}
      */
     _stringifyElementClose(element) {
         const type = this._stringifyElementType(element);
@@ -770,10 +766,6 @@ class ViewStringify {
      * * 'ui' for {@link module:engine/view/uielement~UIElement UI elements},
      * * 'raw' for {@link module:engine/view/rawelement~RawElement raw elements},
      * * an empty string when the current configuration is preventing showing elements' types.
-     *
-     * @private
-     * @param {module:engine/view/element~Element} element
-     * @returns {String}
      */
     _stringifyElementType(element) {
         if (this.showType) {
@@ -791,10 +783,6 @@ class ViewStringify {
      * The priority string representation will be returned when the passed element is an instance of
      * {@link module:engine/view/attributeelement~AttributeElement attribute element} and the current configuration allows to show the
      * priority. Otherwise returns an empty string.
-     *
-     * @private
-     * @param {module:engine/view/element~Element} element
-     * @returns {String}
      */
     _stringifyElementPriority(element) {
         if (this.showPriority && element.is('attributeElement')) {
@@ -808,10 +796,6 @@ class ViewStringify {
      * The id string representation will be returned when the passed element is an instance of
      * {@link module:engine/view/attributeelement~AttributeElement attribute element}, the element has an id
      * and the current configuration allows to show the id. Otherwise returns an empty string.
-     *
-     * @private
-     * @param {module:engine/view/element~Element} element
-     * @returns {String}
      */
     _stringifyElementId(element) {
         if (this.showAttributeElementId && element.is('attributeElement') && element.id) {
@@ -822,10 +806,6 @@ class ViewStringify {
     /**
      * Converts the passed {@link module:engine/view/element~Element element} attributes to their string representation.
      * If an element has no attributes, an empty string is returned.
-     *
-     * @private
-     * @param {module:engine/view/element~Element} element
-     * @returns {String}
      */
     _stringifyElementAttributes(element) {
         const attributes = [];
@@ -851,18 +831,18 @@ class ViewStringify {
         return attributes.join(' ');
     }
 }
-// Converts {@link module:engine/view/element~Element elements} to
-// {@link module:engine/view/attributeelement~AttributeElement attribute elements},
-// {@link module:engine/view/containerelement~ContainerElement container elements},
-// {@link module:engine/view/emptyelement~EmptyElement empty elements} or
-// {@link module:engine/view/uielement~UIElement UI elements}.
-// It converts the whole tree starting from the `rootNode`. The conversion is based on element names.
-// See the `_convertElement` method for more details.
-//
-// @param {module:engine/view/element~Element|module:engine/view/documentfragment~DocumentFragment|module:engine/view/text~Text}
-//  rootNode The root node to convert.
-// @returns {module:engine/view/element~Element|module:engine/view/documentfragment~DocumentFragment|
-// module:engine/view/text~Text} The root node of converted elements.
+/**
+ * Converts {@link module:engine/view/element~Element elements} to
+ * {@link module:engine/view/attributeelement~AttributeElement attribute elements},
+ * {@link module:engine/view/containerelement~ContainerElement container elements},
+ * {@link module:engine/view/emptyelement~EmptyElement empty elements} or
+ * {@link module:engine/view/uielement~UIElement UI elements}.
+ * It converts the whole tree starting from the `rootNode`. The conversion is based on element names.
+ * See the `_convertElement` method for more details.
+ *
+ * @param rootNode The root node to convert.
+ * @returns The root node of converted elements.
+ */
 function _convertViewElements(rootNode) {
     if (rootNode.is('element') || rootNode.is('documentFragment')) {
         // Convert element or leave document fragment.
@@ -888,29 +868,28 @@ function _convertViewElements(rootNode) {
     }
     return rootNode;
 }
-// Converts an {@link module:engine/view/element~Element element} to
-// {@link module:engine/view/attributeelement~AttributeElement attribute element},
-// {@link module:engine/view/containerelement~ContainerElement container element},
-// {@link module:engine/view/emptyelement~EmptyElement empty element} or
-// {@link module:engine/view/uielement~UIElement UI element}.
-// If the element's name is in the format of `attribute:b`, it will be converted to
-// an {@link module:engine/view/attributeelement~AttributeElement attribute element} with a priority of 11.
-// Additionally, attribute elements may have specified priority (for example `view-priority="11"`) and/or
-// id (for example `view-id="foo"`).
-// If the element's name is in the format of `container:p`, it will be converted to
-// a {@link module:engine/view/containerelement~ContainerElement container element}.
-// If the element's name is in the format of `empty:img`, it will be converted to
-// an {@link module:engine/view/emptyelement~EmptyElement empty element}.
-// If the element's name is in the format of `ui:span`, it will be converted to
-// a {@link module:engine/view/uielement~UIElement UI element}.
-// If the element's name does not contain any additional information, a {@link module:engine/view/element~Element view Element} will be
-// returned.
-//
-// @param {module:engine/view/element~Element} viewElement A view element to convert.
-// @returns {module:engine/view/element~Element|module:engine/view/attributeelement~AttributeElement|
-// module:engine/view/emptyelement~EmptyElement|module:engine/view/uielement~UIElement|
-// module:engine/view/containerelement~ContainerElement} A tree view
-// element converted according to its name.
+/**
+ * Converts an {@link module:engine/view/element~Element element} to
+ * {@link module:engine/view/attributeelement~AttributeElement attribute element},
+ * {@link module:engine/view/containerelement~ContainerElement container element},
+ * {@link module:engine/view/emptyelement~EmptyElement empty element} or
+ * {@link module:engine/view/uielement~UIElement UI element}.
+ * If the element's name is in the format of `attribute:b`, it will be converted to
+ * an {@link module:engine/view/attributeelement~AttributeElement attribute element} with a priority of 11.
+ * Additionally, attribute elements may have specified priority (for example `view-priority="11"`) and/or
+ * id (for example `view-id="foo"`).
+ * If the element's name is in the format of `container:p`, it will be converted to
+ * a {@link module:engine/view/containerelement~ContainerElement container element}.
+ * If the element's name is in the format of `empty:img`, it will be converted to
+ * an {@link module:engine/view/emptyelement~EmptyElement empty element}.
+ * If the element's name is in the format of `ui:span`, it will be converted to
+ * a {@link module:engine/view/uielement~UIElement UI element}.
+ * If the element's name does not contain any additional information, a {@link module:engine/view/element~Element view Element} will be
+ * returned.
+ *
+ * @param viewElement A view element to convert.
+ * @returns A tree view element converted according to its name.
+ */
 function _convertElement(viewDocument, viewElement) {
     const info = _convertElementNameAndInfo(viewElement);
     const ElementConstructor = allowedTypes[info.type];
@@ -929,19 +908,21 @@ function _convertElement(viewDocument, viewElement) {
     }
     return newElement;
 }
-// Converts the `view-priority` attribute and the {@link module:engine/view/element~Element#name element's name} information needed for
-// creating {@link module:engine/view/attributeelement~AttributeElement attribute element},
-// {@link module:engine/view/containerelement~ContainerElement container element},
-// {@link module:engine/view/emptyelement~EmptyElement empty element} or
-// {@link module:engine/view/uielement~UIElement UI element}.
-// The name can be provided in two formats: as a simple element's name (`div`), or as a type and name (`container:div`,
-// `attribute:span`, `empty:img`, `ui:span`);
-//
-// @param {module:engine/view/element~Element} element The element whose name should be converted.
-// @returns {Object} info An object with parsed information.
-// @returns {String} info.name The parsed name of the element.
-// @returns {String|null} info.type The parsed type of the element. It can be `attribute`, `container` or `empty`.
-// returns {Number|null} info.priority The parsed priority of the element.
+/**
+ * Converts the `view-priority` attribute and the {@link module:engine/view/element~Element#name element's name} information needed for
+ * creating {@link module:engine/view/attributeelement~AttributeElement attribute element},
+ * {@link module:engine/view/containerelement~ContainerElement container element},
+ * {@link module:engine/view/emptyelement~EmptyElement empty element} or
+ * {@link module:engine/view/uielement~UIElement UI element}.
+ * The name can be provided in two formats: as a simple element's name (`div`), or as a type and name (`container:div`,
+ * `attribute:span`, `empty:img`, `ui:span`);
+ *
+ * @param viewElement The element whose name should be converted.
+ * @returns An object with parsed information:
+ * * `name` The parsed name of the element.
+ * * `type` The parsed type of the element. It can be `attribute`, `container` or `empty`.
+ * * `priority` The parsed priority of the element.
+ */
 function _convertElementNameAndInfo(viewElement) {
     const parts = viewElement.name.split(':');
     const priority = _convertPriority(viewElement.getAttribute('view-priority'));
@@ -968,17 +949,15 @@ function _convertElementNameAndInfo(viewElement) {
     }
     throw new Error(`Parse error - cannot parse element's name: ${viewElement.name}.`);
 }
-// Checks if the element's type is allowed. Returns `attribute`, `container`, `empty` or `null`.
-//
-// @param {String} type
-// @returns {String|null}
+/**
+ * Checks if the element's type is allowed. Returns `attribute`, `container`, `empty` or `null`.
+ */
 function _convertType(type) {
     return type in allowedTypes ? type : null;
 }
-// Checks if a given priority is allowed. Returns null if the priority cannot be converted.
-//
-// @param {String} priorityString
-// returns {Number|null}
+/**
+ * Checks if a given priority is allowed. Returns null if the priority cannot be converted.
+ */
 function _convertPriority(priorityString) {
     const priority = parseInt(priorityString, 10);
     if (!isNaN(priority)) {