8
0
Quellcode durchsuchen

Docs: converting docs to the new format.

Maciek vor 9 Jahren
Ursprung
Commit
8baab1fbb8
25 geänderte Dateien mit 76 neuen und 82 gelöschten Zeilen
  1. 0 2
      packages/ckeditor5-engine/src/conversion/buildmodelconverter.js
  2. 0 2
      packages/ckeditor5-engine/src/conversion/buildviewconverter.js
  3. 10 10
      packages/ckeditor5-engine/src/conversion/viewconversiondispatcher.js
  4. 1 1
      packages/ckeditor5-engine/src/dataprocessor/htmldataprocessor.js
  5. 2 2
      packages/ckeditor5-engine/src/dataprocessor/xmldataprocessor.js
  6. 1 1
      packages/ckeditor5-engine/src/model/delta/deltafactory.js
  7. 2 2
      packages/ckeditor5-engine/src/model/document.js
  8. 1 1
      packages/ckeditor5-engine/src/model/element.js
  9. 7 1
      packages/ckeditor5-engine/src/model/liveselection.js
  10. 4 4
      packages/ckeditor5-engine/src/model/operation/operation.js
  11. 1 1
      packages/ckeditor5-engine/src/model/schema.js
  12. 1 1
      packages/ckeditor5-engine/src/model/writer.js
  13. 1 1
      packages/ckeditor5-engine/src/view/attributeelement.js
  14. 1 1
      packages/ckeditor5-engine/src/view/containerelement.js
  15. 1 1
      packages/ckeditor5-engine/src/view/document.js
  16. 11 11
      packages/ckeditor5-engine/src/view/domconverter.js
  17. 1 1
      packages/ckeditor5-engine/src/view/emptyelement.js
  18. 16 24
      packages/ckeditor5-engine/src/view/filler.js
  19. 1 1
      packages/ckeditor5-engine/src/view/node.js
  20. 3 3
      packages/ckeditor5-engine/src/view/observer/clickobserver.js
  21. 1 1
      packages/ckeditor5-engine/src/view/observer/fakeselectionobserver.js
  22. 2 2
      packages/ckeditor5-engine/src/view/observer/mouseobserver.js
  23. 2 2
      packages/ckeditor5-engine/src/view/range.js
  24. 2 2
      packages/ckeditor5-engine/src/view/renderer.js
  25. 4 4
      packages/ckeditor5-engine/src/view/writer.js

+ 0 - 2
packages/ckeditor5-engine/src/conversion/buildmodelconverter.js

@@ -290,8 +290,6 @@ class ModelConverterBuilder {
  * Entry point for model-to-view converters builder. This chainable API makes it easy to create basic, most common
  * model-to-view converters and attach them to provided dispatchers. The method returns an instance of
  * {@link module:engine/conversion/buildmodelconverter~ModelConverterBuilder}.
- *
- * @external module:engine/conversion/buildmodelconverter~buildModelConverter
  */
 export default function buildModelConverter() {
 	return new ModelConverterBuilder();

+ 0 - 2
packages/ckeditor5-engine/src/conversion/buildviewconverter.js

@@ -416,8 +416,6 @@ function setAttributeOn( toChange, attribute, data, conversionApi ) {
  * Entry point for view-to-model converters builder. This chainable API makes it easy to create basic, most common
  * view-to-model converters and attach them to provided dispatchers. The method returns an instance of
  * {@link module:engine/conversion/buildviewconverter~ViewConverterBuilder}.
- *
- * @external module:engine/conversion/buildviewconverter~buildViewConverter
  */
 export default function buildViewConverter() {
 	return new ViewConverterBuilder();

+ 10 - 10
packages/ckeditor5-engine/src/conversion/viewconversiondispatcher.js

@@ -129,7 +129,7 @@ export default class ViewConversionDispatcher {
 	 * @param {module:engine/view/documentfragment~DocumentFragment|module:engine/view/element~Element}
 	 * viewItem Part of the view to be converted.
 	 * @param {Object} [additionalData] Additional data to be passed in `data` argument when firing `ViewConversionDispatcher`
-	 * events. See also {@link #event:element element event}.
+	 * events. See also {@link ~ViewConversionDispatcher#event:element element event}.
 	 * @returns {module:engine/model/documentfragment~DocumentFragment} Model document fragment that is a result of the conversion process.
 	 */
 	convert( viewItem, additionalData = {} ) {
@@ -240,15 +240,15 @@ mix( ViewConversionDispatcher, EmitterMixin );
  * Every fired event is passed (as first parameter) an object with `output` property. Every event may set and/or
  * modify that property. When all callbacks are done, the final value of `output` property is returned by this method.
  *
- * @function covertItem
- * @fires element
- * @fires text
- * @fires documentFragment
+ * @function convertItem
+ * @fires module:engine/conversion/viewconversiondispatcher~ViewConversionDispatcher#event:element
+ * @fires module:engine/conversion/viewconversiondispatcher~ViewConversionDispatcher#event:text
+ * @fires module:engine/conversion/viewconversiondispatcher~ViewConversionDispatcher#event:documentFragment
  * @param {module:engine/view/documentfragment~DocumentFragment|module:engine/view/element~Element|module:engine/view/text~Text}
  * input Item to convert.
  * @param {module:engine/conversion/viewconsumable~ViewConsumable} consumable Values to consume.
  * @param {Object} [additionalData] Additional data to be passed in `data` argument when firing `ViewConversionDispatcher`
- * events. See also {@link #event:element element event}.
+ * events. See also {@link ~ViewConversionDispatcher#event:element element event}.
  * @returns {*} The result of item conversion, created and modified by callbacks attached to fired event.
  */
 
@@ -256,13 +256,13 @@ mix( ViewConversionDispatcher, EmitterMixin );
  * Starts conversion of all children of given item by firing appropriate events for all those children.
  *
  * @function convertChildren
- * @fires element
- * @fires text
- * @fires documentFragment
+ * @fires module:engine/conversion/viewconversiondispatcher~ViewConversionDispatcher#event:element
+ * @fires module:engine/conversion/viewconversiondispatcher~ViewConversionDispatcher#event:text
+ * @fires module:engine/conversion/viewconversiondispatcher~ViewConversionDispatcher#event:documentFragment
  * @param {module:engine/view/documentfragment~DocumentFragment|module:engine/view/element~Element}
  * input Item which children will be converted.
  * @param {module:engine/conversion/viewconsumable~ViewConsumable} consumable Values to consume.
  * @param {Object} [additionalData] Additional data to be passed in `data` argument when firing `ViewConversionDispatcher`
- * events. See also {@link #event:element element event}.
+ * events. See also {@link ~ViewConversionDispatcher#event:element element event}.
  * @returns {Array.<*>} Array containing results of conversion of all children of given item.
  */

+ 1 - 1
packages/ckeditor5-engine/src/dataprocessor/htmldataprocessor.js

@@ -17,7 +17,7 @@ import { NBSP_FILLER } from '../view/filler.js';
  * HtmlDataProcessor class.
  * This data processor implementation uses HTML as input/output data.
  *
- * @implements engine.dataProcessor.DataProcessor
+ * @implements module:engine/dataprocessor/dataprocessor~DataProcessor
  */
 export default class HtmlDataProcessor {
 	/**

+ 2 - 2
packages/ckeditor5-engine/src/dataprocessor/xmldataprocessor.js

@@ -19,7 +19,7 @@ import { NBSP_FILLER } from '../view/filler.js';
  * This class is needed because unlike HTML, XML allows to use any tag with any value.
  * E.g. `<link>Text</link>` is a valid XML but invalid HTML.
  *
- * @implements engine.dataProcessor.DataProcessor
+ * @implements module:engine/dataprocessor/dataprocessor~DataProcessor
  */
 export default class XmlDataProcessor {
 	/**
@@ -52,7 +52,7 @@ export default class XmlDataProcessor {
 		 * DOM converter used to convert DOM elements to view elements.
 		 *
 		 * @private
-		 * @member {module:engine/view/domconverter~DomConverter}.
+		 * @member {module:engine/view/domconverter~DomConverter}
 		 */
 		this._domConverter = new DomConverter( { blockFiller: NBSP_FILLER } );
 

+ 1 - 1
packages/ckeditor5-engine/src/model/delta/deltafactory.js

@@ -27,7 +27,7 @@ export default class DeltaFactory {
 	 *
 	 * @param {Object} json
 	 * @param {module:engine/model/document~Document} doc Document on which this delta will be applied.
-	 * @returns {module:engine/model/delta/delta~Delta.InsertDelta}
+	 * @returns {module:engine/model/delta/insertdelta~InsertDelta}
 	 */
 	static fromJSON( json, doc ) {
 		if ( !deserializers.has( json.__className ) ) {

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

@@ -48,8 +48,8 @@ export default class Document {
 		/**
 		 * Document version. It starts from `0` and every operation increases the version number. It is used to ensure that
 		 * operations are applied on the proper document version.
-		 * If the {@link module:engine/model/operation/operation~Operation#baseVersion} will
-		 * not match document version the {@link document-applyOperation-wrong-version} error is thrown.
+		 * If the {@link module:engine/model/operation/operation~Operation#baseVersion} will not match document version the
+		 * {@link module:utils/ckeditorerror~CKEditorError model-document-applyOperation-wrong-version} error is thrown.
 		 *
 		 * @readonly
 		 * @member {Number}

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

@@ -210,7 +210,7 @@ export default class Element extends Node {
 	 *		this.getNodeByPath( [ 1, 0 ] );  // -> "c"
 	 *
 	 * @param {Array.<Number>} relativePath Path of the node to find, relative to this element.
-	 * @returns {engine.model.Node}
+	 * @returns {module:engine/model/node~Node}
 	 */
 	getNodeByPath( relativePath ) {
 		let node = this;

+ 7 - 1
packages/ckeditor5-engine/src/model/liveselection.js

@@ -40,6 +40,8 @@ const attrOpTypes = new Set(
  * that are inside {@link module:engine/model/documentfragment~DocumentFragment document fragment}.
  * If you need to represent a selection in document fragment,
  * use {@link module:engine/model/selection~Selection "normal" selection} instead.
+ *
+ * @extends module:engine/model/selection~Selection
  */
 export default class LiveSelection extends Selection {
 	/**
@@ -316,7 +318,7 @@ export default class LiveSelection extends Selection {
 	 *
 	 * @protected
 	 * @param {Boolean} clearAll
-	 * @fires module:engine/model/liveselection~LiveSelection#change:attribute
+	 * @fires change:attribute
 	 */
 	_updateAttributes( clearAll ) {
 		const newAttributes = toMap( this._getSurroundingAttributes() );
@@ -637,6 +639,10 @@ export default class LiveSelection extends Selection {
 	}
 }
 
+/**
+ * @event change:attribute
+ */
+
 // Helper function for {@link module:engine/model/liveselection~LiveSelection#_updateAttributes}. It takes model item, checks whether
 // it is a text node (or text proxy) and if so, returns it's attributes. If not, returns `null`.
 //

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

@@ -23,8 +23,8 @@ export default class Operation {
 		/**
 		 * {@link module:engine/model/document~Document#version} on which operation can be applied. If you try to
 		 * {@link module:engine/model/document~Document#applyOperation apply} operation with different base version than the
-		 * {@link module:engine/model/document~Document#version document version} the {@link document-applyOperation-wrong-version}
-		 * error is thrown.
+		 * {@link module:engine/model/document~Document#version document version} the
+		 * {@link module:utils/ckeditorerror~CKEditorError model-document-applyOperation-wrong-version} error is thrown.
 		 *
 		 * @member {Number} #baseVersion
 		 */
@@ -48,7 +48,7 @@ export default class Operation {
 		 * Creates and returns an operation that has the same parameters as this operation.
 		 *
 		 * @method #clone
-		 * @returns {} Clone of this operation.
+		 * @returns {module:engine/model/operation/operation~Operation} Clone of this operation.
 		 */
 
 		/**
@@ -61,7 +61,7 @@ export default class Operation {
 		 * {@link module:engine/model/operation/transform~transform} it by all operations that were executed after the original operation.
 		 *
 		 * @method #getReversed
-		 * @returns {} Reversed operation.
+		 * @returns {module:engine/model/operation/operation~Operation} Reversed operation.
 		 */
 
 		/**

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

@@ -440,7 +440,7 @@ export default class Schema {
 	 * Checks whether there is an item registered under given name in schema.
 	 *
 	 * @param itemName
-	 * @returns {boolean}
+	 * @returns {Boolean}
 	 */
 	hasItem( itemName ) {
 		return this._items.has( itemName );

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

@@ -26,7 +26,7 @@ import CKEditorError from '../../utils/ckeditorerror.js';
  * {@link module:engine/model/documentfragment~DocumentFragment document fragments},
  * * model writer API operates on {@link module:engine/model/position~Position positions}, which means that you have
  * better control over manipulating model tree as positions operate on offsets rather than indexes,
- * * model writer API automatically merges {@link module:engine/model/textnode~TextNode text nodes} with same attributes, which means
+ * * model writer API automatically merges {@link module:engine/model/text~Text text nodes} with same attributes, which means
  * lower memory usage and better efficiency.
  *
  * @namespace writer

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

@@ -70,7 +70,7 @@ export default class AttributeElement extends Element {
 	}
 
 	/**
-	 * Returns block {@link module:engine/view/filter~Filter filler} offset or `null` if a block filler is not needed.
+	 * Returns block {@link module:engine/view/filler filler} offset or `null` if a block filler is not needed.
 	 *
 	 * @returns {Number|null} Block filler offset or `null` if block filler is not needed.
 	 */

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

@@ -55,7 +55,7 @@ export default class ContainerElement extends Element {
 	}
 
 	/**
-	 * Returns block {@link module:engine/view/filter~Filter filler} offset or `null` if block filler is not needed.
+	 * Returns block {@link module:engine/view/filler filler} offset or `null` if block filler is not needed.
 	 *
 	 * @returns {Number|null} Block filler offset or `null` if block filler is not needed.
 	 */

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

@@ -38,7 +38,7 @@ import ObservableMixin from '../../utils/observablemixin.js';
  * * {@link module:engine/view/observer/keyobserver~KeyObserver},
  * * {@link module:engine/view/observer/fakeselectionobserver~FakeSelectionObserver}.
  *
- * @mixes utils.EmitterMixin
+ * @mixes module:utils/emittermixin~EmitterMixin
  */
 export default class Document {
 	/**

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

@@ -38,7 +38,7 @@ export default class DomConverter {
 	 * Creates DOM converter.
 	 *
 	 * @param {Object} options Object with configuration options.
-	 * @param {Function} [options.blockFiller=module:engine/view/filter~Filter.BR_FILLER] Block filler creator.
+	 * @param {Function} [options.blockFiller=module:engine/view/filler~BR_FILLER] Block filler creator.
 	 */
 	constructor( options = {} ) {
 		// Using WeakMap prevent memory leaks: when the converter will be destroyed all referenced between View and DOM
@@ -52,7 +52,7 @@ export default class DomConverter {
 		// I've been here. Seen stuff. Afraid of code now.
 
 		/**
-		 * Block {@link module:engine/view/filter~Filter filler} creator, which is used to create all block fillers during the
+		 * Block {@link module:engine/view/filler filler} creator, which is used to create all block fillers during the
 		 * view to DOM conversion and to recognize block fillers during the DOM to view conversion.
 		 *
 		 * @readonly
@@ -204,7 +204,7 @@ export default class DomConverter {
 
 	/**
 	 * Converts children of the view element to DOM using {@link module:engine/view/domconverter~DomConverter#viewToDom} method.
-	 * Additionally this method adds block {@link module:engine/view/filter~Filter filler} to the list of children, if needed.
+	 * Additionally this method adds block {@link module:engine/view/filler filler} to the list of children, if needed.
 	 *
 	 * @param {module:engine/view/element~Element|module:engine/view/documentfragment~DocumentFragment} viewElement Parent view element.
 	 * @param {document} domDocument Document which will be used to create DOM nodes.
@@ -232,7 +232,7 @@ export default class DomConverter {
 
 	/**
 	 * Converts view {@link module:engine/view/range~Range} to DOM range.
-	 * Inline and block {@link module:engine/view/filter~Filter fillers} are handled during the conversion.
+	 * Inline and block {@link module:engine/view/filler fillers} are handled during the conversion.
 	 *
 	 * @param {module:engine/view/range~Range} viewRange View range.
 	 * @returns {Range} DOM range.
@@ -251,7 +251,7 @@ export default class DomConverter {
 	/**
 	 * Converts view {@link module:engine/view/position~Position} to DOM parent and offset.
 	 *
-	 * Inline and block {@link module:engine/view/filter~Filter fillers} are handled during the conversion.
+	 * Inline and block {@link module:engine/view/filler fillers} are handled during the conversion.
 	 * If the converted position is directly before inline filler it is moved inside the filler.
 	 *
 	 * @param {module:engine/view/position~Position} viewPosition View position.
@@ -317,7 +317,7 @@ export default class DomConverter {
 	/**
 	 * Converts DOM to view. For all text nodes, not bound elements and document fragments new items will
 	 * be created. For bound elements and document fragments function will return corresponding items. For
-	 * {@link module:engine/view/filter~Filter fillers} `null` will be returned.
+	 * {@link module:engine/view/filler fillers} `null` will be returned.
 	 *
 	 * @param {Node|DocumentFragment} domNode DOM node or document fragment to transform.
 	 * @param {Object} [options] Conversion options.
@@ -326,7 +326,7 @@ export default class DomConverter {
 	 * @param {Boolean} [options.keepOriginalCase=false] If `false`, node's tag name will be converter to lower case.
 	 * @returns {module:engine/view/node~Node|module:engine/view/documentfragment~DocumentFragment|null} Converted node or document fragment or
 	 * `null`
-	 * if DOM node is a {@link module:engine/view/filter~Filter filler} or the given node is an empty text node.
+	 * if DOM node is a {@link module:engine/view/filler filler} or the given node is an empty text node.
 	 */
 	domToView( domNode, options = {} ) {
 		if ( isBlockFiller( domNode, this.blockFiller )  ) {
@@ -384,7 +384,7 @@ export default class DomConverter {
 
 	/**
 	 * Converts children of the DOM element to view nodes using {@link module:engine/view/domconverter~DomConverter#domToView} method.
-	 * Additionally this method omits block {@link module:engine/view/filter~Filter filler}, if it exists in the DOM parent.
+	 * Additionally this method omits block {@link module:engine/view/filler filler}, if it exists in the DOM parent.
 	 *
 	 * @param {HTMLElement} domElement Parent DOM element.
 	 * @param {Object} options See {@link module:engine/view/domconverter~DomConverter#domToView} options parameter.
@@ -463,7 +463,7 @@ export default class DomConverter {
 	/**
 	 * Converts DOM parent and offset to view {@link module:engine/view/position~Position}.
 	 *
-	 * If the position is inside a {@link module:engine/view/filter~Filter filler} which has no corresponding view node,
+	 * If the position is inside a {@link module:engine/view/filler filler} which has no corresponding view node,
 	 * position of the filler will be converted and returned.
 	 *
 	 * If structures are too different and it is not possible to find corresponding position then `null` will be returned.
@@ -524,7 +524,7 @@ export default class DomConverter {
 	 * nodes and {@link module:engine/view/domconverter~DomConverter#getCorrespondingViewDocumentFragment getCorrespondingViewDocumentFragment}
 	 * for document fragments.
 	 *
-	 * Note that for the block or inline {@link module:engine/view/filter~Filter filler} this method returns `null`.
+	 * Note that for the block or inline {@link module:engine/view/filler filler} this method returns `null`.
 	 *
 	 * @param {Node|DocumentFragment} domNode DOM node or document fragment.
 	 * @returns {module:engine/view/node~Node|module:engine/view/documentfragment~DocumentFragment|null} Corresponding view item.
@@ -576,7 +576,7 @@ export default class DomConverter {
 	 *
 	 * Otherwise `null` is returned.
 	 *
-	 * Note that for the block or inline {@link module:engine/view/filter~Filter filler} this method returns `null`.
+	 * Note that for the block or inline {@link module:engine/view/filler filler} this method returns `null`.
 	 *
 	 * @param {Text} domText DOM text node.
 	 * @returns {module:engine/view/text~Text|null} Corresponding view text node or `null`, if it was not possible to find a

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

@@ -35,7 +35,7 @@ export default class EmptyElement extends Element {
 	 * Clones provided element. Overrides {@link module:engine/view/element~Element#clone} method, as it's forbidden to pass child
 	 * nodes to EmptyElement's constructor.
 	 *
-	 * @returns {envine.view.EmptyElement} Clone of this element.
+	 * @returns {module:engine/view/emptyelement~EmptyElement} Clone of this element.
 	 */
 	clone() {
 		const cloned = new this.constructor( this.name, this._attrs );

+ 16 - 24
packages/ckeditor5-engine/src/view/filler.js

@@ -3,10 +3,6 @@
  * For licensing, see LICENSE.md.
  */
 
-/**
- * @module engine/view/filler
- */
-
 /* globals window, Range, Text */
 
 import { keyCodes } from '../../utils/keyboard.js';
@@ -22,13 +18,13 @@ import { keyCodes } from '../../utils/keyboard.js';
  * as browsers do natively. So instead of an empty `<p>` there will be `<p><br></p>`. The advantage of block filler is that
  * it is transparent for the selection, so when the caret is before the `<br>` and user presses right arrow he will be
  * moved to the next paragraph, not after the `<br>`. The disadvantage is that it breaks a block, so it can not be used
- * in the middle of a line of text. The {@link module:engine/view/filter~Filter.BR_FILLER `<br>` filler} can be replaced with any other
- * character in the data output, for instance {@link module:engine/view/filter~Filter.NBSP_FILLER non-breaking space}.
+ * in the middle of a line of text. The {@link module:engine/view/filler~BR_FILLER `<br>` filler} can be replaced with any other
+ * character in the data output, for instance {@link module:engine/view/filler~NBSP_FILLER non-breaking space}.
  *
  * * Inline filler is a filler which does not break a line of text, so it can be used inside the text, for instance in the empty
  * `<b>` surrendered by text: `foo<b></b>bar`, if we want to put the caret there. CKEditor uses a sequence of the zero-width
- * spaces as an {@link module:engine/view/filter~Filter.INLINE_FILLER inline filler} having the predetermined
- * {@link module:engine/view/filter~Filter.INLINE_FILLER_LENGTH length}. A sequence is used, instead of a single character to
+ * spaces as an {@link module:engine/view/filler~INLINE_FILLER inline filler} having the predetermined
+ * {@link module:engine/view/filler~INLINE_FILLER_LENGTH length}. A sequence is used, instead of a single character to
  * avoid treating random zero-width spaces as the inline filler. Disadvantage of the inline filler is that it is not
  * transparent for the selection. The arrow key moves the caret between zero-width spaces characters, so the additional
  * code is needed to handle the caret.
@@ -36,15 +32,15 @@ import { keyCodes } from '../../utils/keyboard.js';
  * Both inline and block fillers are handled by the {@link module:engine/view/renderer~Renderer renderer} and are not present in the
  * view.
  *
- * @namespace module:engine/view/filter~Filter
+ * @module engine/view/filler
  */
 
 /**
  * `<br> filler creator. This is a function which creates `<br data-cke-filler="true">` element.
  * It defines how the filler is created.
  *
- * @see module:engine/view/filter~Filter.NBSP_FILLER_FILLER
- * @member {Function} module:engine/view/filter~Filter.BR_FILLER
+ * @see module:engine/view/filler~NBSP_FILLER_FILLER
+ * @function
  */
 export const BR_FILLER = ( domDocument ) => {
 	const fillerBr = domDocument.createElement( 'br' );
@@ -57,22 +53,18 @@ export const BR_FILLER = ( domDocument ) => {
  * Non-breaking space filler creator. This is a function which creates `&nbsp;` text node.
  * It defines how the filler is created.
  *
- * @see module:engine/view/filter~Filter.BR_FILLER
- * @member {Function} module:engine/view/filter~Filter.NBSP_FILLER_FILLER
+ * @see module:engine/view/filler~BR_FILLER
+ * @function
  */
 export const NBSP_FILLER = ( domDocument ) => domDocument.createTextNode( '\u00A0' );
 
 /**
- * Length of the {@link module:engine/view/filter~Filter.INLINE_FILLER INLINE_FILLER}.
- *
- * @member {Function} module:engine/view/filter~Filter.INLINE_FILLER_LENGTH
+ * Length of the {@link module:engine/view/filler~INLINE_FILLER INLINE_FILLER}.
  */
 export const INLINE_FILLER_LENGTH = 7;
 
 /**
  * Inline filler which is sequence of the zero width spaces.
- *
- * @member {String} module:engine/view/filter~Filter.INLINE_FILLER
  */
 export let INLINE_FILLER = '';
 
@@ -81,7 +73,7 @@ for ( let i = 0; i < INLINE_FILLER_LENGTH; i++ ) {
 }
 
 /**
- * Checks if the node is a text node which starts with the {@link module:engine/view/filter~Filter.INLINE_FILLER inline filler}.
+ * Checks if the node is a text node which starts with the {@link module:engine/view/filler~INLINE_FILLER inline filler}.
  *
  *		startsWithFiller( document.createTextNode( INLINE_FILLER ) ); // true
  *		startsWithFiller( document.createTextNode( INLINE_FILLER + 'foo' ) ); // true
@@ -89,27 +81,27 @@ for ( let i = 0; i < INLINE_FILLER_LENGTH; i++ ) {
  *		startsWithFiller( document.createElement( 'p' ) ); // false
  *
  * @param {Node} domNode DOM node.
- * @returns {Boolean} True if the text node starts with the {@link module:engine/view/filter~Filter.INLINE_FILLER inline filler}.
+ * @returns {Boolean} True if the text node starts with the {@link module:engine/view/filler~INLINE_FILLER inline filler}.
  */
 export function startsWithFiller( domNode ) {
 	return ( domNode instanceof Text ) && ( domNode.data.substr( 0, INLINE_FILLER_LENGTH ) === INLINE_FILLER );
 }
 
 /**
- * Checks if the text node contains only the {@link module:engine/view/filter~Filter.INLINE_FILLER inline filler}.
+ * Checks if the text node contains only the {@link module:engine/view/filler~INLINE_FILLER inline filler}.
  *
  *		isInlineFiller( document.createTextNode( INLINE_FILLER ) ); // true
  *		isInlineFiller( document.createTextNode( INLINE_FILLER + 'foo' ) ); // false
  *
  * @param {Text} domText DOM text node.
- * @returns {Boolean} True if the text node contains only the {@link module:engine/view/filter~Filter.INLINE_FILLER inline filler}.
+ * @returns {Boolean} True if the text node contains only the {@link module:engine/view/filler~INLINE_FILLER inline filler}.
  */
 export function isInlineFiller( domText ) {
 	return domText.data.length == INLINE_FILLER_LENGTH && startsWithFiller( domText );
 }
 
 /**
- * Get string data from the text node, removing an {@link module:engine/view/filter~Filter.INLINE_FILLER inline filler} from it,
+ * Get string data from the text node, removing an {@link module:engine/view/filler~INLINE_FILLER inline filler} from it,
  * if text node contains it.
  *
  *		getDataWithoutFiller( document.createTextNode( INLINE_FILLER + 'foo' ) ) == 'foo' // true
@@ -137,7 +129,7 @@ const templateBlockFillers = new WeakMap();
  *
  * @param {Node} domNode DOM node to check.
  * @param {Function} blockFiller Block filler creator.
- * @returns {Boolean} True if text node contains only {@link module:engine/view/filter~Filter.INLINE_FILLER inline filler}.
+ * @returns {Boolean} True if text node contains only {@link module:engine/view/filler~INLINE_FILLER inline filler}.
  */
 export function isBlockFiller( domNode, blockFiller ) {
 	let templateBlockFiller = templateBlockFillers.get( blockFiller );

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

@@ -196,7 +196,7 @@ export default class Node {
  *
  * Change event is bubbled – it is fired on all ancestors.
  *
- * @event text
+ * @event change:text
  * @param {module:engine/view/node~Node} Changed node.
  */
 

+ 3 - 3
packages/ckeditor5-engine/src/view/observer/clickobserver.js

@@ -12,11 +12,11 @@ import DomEventObserver from './domeventobserver.js';
 /**
  * {@link module:engine/view/document~Document#event:click Click} event observer.
  *
- * Note that this observer is not available by default. To make it available it needs to be added to {@link
- * module:engine/view/document~Document}
+ * Note that this observer is not available by default. To make it available it needs to be added to
+ * {@link module:engine/view/document~Document}
  * by a {@link module:engine/view/document~Document#addObserver} method.
  *
- * @extends module:engine/view/observer/observer~Observer.DomEventObserver
+ * @extends module:engine/view/observer/domeventobserver~DomEventObserver
  */
 export default class ClickObserver extends DomEventObserver {
 	constructor( document ) {

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

@@ -57,7 +57,7 @@ export default class FakeSelectionObserver extends Observer {
 	 *
 	 * @private
 	 * @param {Number} keyCode
-	 * @fires module:engine/view/document~Document#selectionChage
+	 * @fires module:engine/view/document~Document#event:selectionChange
 	 */
 	_handleSelectionMove( keyCode ) {
 		const selection = this.document.selection;

+ 2 - 2
packages/ckeditor5-engine/src/view/observer/mouseobserver.js

@@ -12,8 +12,8 @@ import DomEventObserver from './domeventobserver.js';
 /**
  * Mouse events observer.
  *
- * Note that this observer is not available by default. To make it available it needs to be added to {@link
- * module:engine/view/document~Document}
+ * Note that this observer is not available by default. To make it available it needs to be added to
+ * {@link module:engine/view/document~Document}
  * by {@link module:engine/view/document~Document#addObserver} method.
  *
  * @extends module:engine/view/observer/domeventobserver~DomEventObserver

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

@@ -113,8 +113,8 @@ export default class Range {
 	}
 
 	/**
-	 * Computes which part(s) of this {@link module:engine/view/range~Range range} is not a part of given {@link module:engine/view/range~Range
-	 * range}.
+	 * Computes which part(s) of this {@link module:engine/view/range~Range range} is not a part of given
+	 * {@link module:engine/view/range~Range range}.
 	 * Returned array contains zero, one or two {@link module:engine/view/range~Range ranges}.
 	 *
 	 * Examples:

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

@@ -173,7 +173,7 @@ export default class Renderer {
 	 * For elements, which child lists have changed, it calculates a {@link module:utils/diff~diff} and adds or removes children which have
 	 * changed.
 	 *
-	 * Rendering also handles {@link module:engine/view/filter~Filter fillers}. Especially, it checks if the inline filler is needed
+	 * Rendering also handles {@link module:engine/view/filler fillers}. Especially, it checks if the inline filler is needed
 	 * at selection position and adds or removes it. To prevent breaking text composition inline filler will not be
 	 * removed as long selection is in the text node which needed it at first.
 	 */
@@ -337,7 +337,7 @@ export default class Renderer {
 	}
 
 	/**
-	 * Checks if the inline {@link module:engine/view/filter~Filter filler} should be added.
+	 * Checks if the inline {@link module:engine/view/filler filler} should be added.
 	 *
 	 * @private
 	 * @returns {Boolean} True if the inline fillers should be added.

+ 4 - 4
packages/ckeditor5-engine/src/view/writer.js

@@ -23,7 +23,7 @@ import isIterable from '../../utils/isiterable.js';
  * @namespace writer
  */
 
-export default {
+const writer = {
 	breakAttributes,
 	breakContainer,
 	mergeAttributes,
@@ -37,6 +37,8 @@ export default {
 	rename
 };
 
+export default writer;
+
 /**
  * Breaks attribute nodes at provided position or at boundaries of provided range. It breaks attribute elements inside
  * up to a container element.
@@ -462,10 +464,9 @@ export function wrap( range, attribute ) {
  * Throws {@link module:utils/ckeditorerror~CKEditorError} `view-writer-wrap-invalid-attribute` when passed attribute element is not
  * an instance of {module:engine/view/attributeelement~AttributeElement AttributeElement}.
  *
- * @function module:engine/view/writer~writer.wrapPosition
  * @param {module:engine/view/position~Position} position
  * @param {module:engine/view/attributeelement~AttributeElement} attribute
- * @returns {Position} New position after wrapping.
+ * @returns {module:engine/view/position~Position} New position after wrapping.
  */
 export function wrapPosition( position, attribute ) {
 	if ( !( attribute instanceof AttributeElement ) ) {
@@ -524,7 +525,6 @@ export function wrapPosition( position, attribute ) {
  * {@link module:engine/view/range~Range#start start} and {@link module:engine/view/range~Range#end end} positions are not placed inside
  * same parent container.
  *
- * @function module:engine/view/writer~writer.unwrap
  * @param {module:engine/view/range~Range} range
  * @param {module:engine/view/attributeelement~AttributeElement} element
  */