8
0
Pārlūkot izejas kodu

Docs: fixing references.

Maciej Bukowski 9 gadi atpakaļ
vecāks
revīzija
54d1427716

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

@@ -34,7 +34,7 @@ import getSelectedContent from './getselectedcontent.js';
  * and {@link ~DataController#set set} data of the {@link ~DataController#model model}
  * using given:
  *
- * * {@link module:engine/dataprocessor/dataProcessor~DataProcessor data processor},
+ * * {@link module:engine/dataprocessor/dataprocessor~DataProcessor data processor},
  * * {@link module:engine/conversion/modelconversiondispatcher~ModelConversionDispatcher model to view} and
  * * {@link module:engine/conversion/viewconversiondispatcher~ViewConversionDispatcher view to model} converters.
  *
@@ -45,7 +45,7 @@ export default class DataController {
 	 * Creates data controller instance.
 	 *
 	 * @param {module:engine/model/document~Document} model Document model.
-	 * @param {module:engine/dataprocessor/dataProcessor~DataProcessor} [dataProcessor] Data processor which should used by the controller.
+	 * @param {module:engine/dataprocessor/dataprocessor~DataProcessor} [dataProcessor] Data processor which should used by the controller.
 	 */
 	constructor( model, dataProcessor ) {
 		/**
@@ -271,7 +271,7 @@ export default class DataController {
 	/**
 	 * See {@link module:engine/controller/getselectedcontent~getSelectedContent}.
 	 *
-	 * @fires engine.controller.DataController#getSelectedContent
+	 * @fires module:engine/controller/datacontroller~DataController#getSelectedContent
 	 * @param {module:engine/model/selection~Selection} selection The selection of which content will be retrieved.
 	 * @returns {module:engine/model/documentfragment~DocumentFragment} Document fragment holding the clone of the selected content.
 	 */
@@ -288,7 +288,7 @@ mix( DataController, EmitterMixin );
 
 /**
  * Event fired when {@link #insertContent} method is called.
- * The {@link .insertContent default action of that method} is implemented as a
+ * The {@link #insertContent default action of that method} is implemented as a
  * listener to this event so it can be fully customized by the features.
  *
  * @event insertContent
@@ -322,11 +322,11 @@ mix( DataController, EmitterMixin );
  */
 
 /**
- * Event fired when {@link engine.controller.DataController#getSelectedContent} method is called.
+ * Event fired when {@link module:engine/controller/datacontroller~DataController#getSelectedContent} method is called.
  * The {@link module:engine/controller/getselectedcontent~getSelectedContent default action of that method} is implemented as a
  * listener to this event so it can be fully customized by the features.
  *
- * @event engine.controller.DataController#getSelectedContent
+ * @event module:engine/controller/datacontroller~DataController#getSelectedContent
  * @param {Object} data
  * @param {module:engine/model/selection~Selection} data.selection
  * @param {module:engine/model/documentfragment~DocumentFragment} data.content The document fragment to return

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

@@ -146,8 +146,8 @@ export default class Delta {
 	}
 
 	/**
-	 * Delta class name. Used by {@link module:engine/model/delta/delta~Delta#toJSON} method for serialization and
-	 * {@link module:engine/model/delta/delta~DeltaFactory.fromJSON} during deserialization.
+	 * Delta class name. Used by {@link #toJSON} method for serialization and
+	 * {@link module:engine/model/delta/deltafactory~DeltaFactory.fromJSON} during deserialization.
 	 *
 	 * @type {String}
 	 * @readonly

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

@@ -44,7 +44,7 @@ export default class InsertDelta extends Delta {
 	 *
 	 * @readonly
 	 * @protected
-	 * @type {module:engine/model/operation/insertoperation~insertOperation|null}
+	 * @type {module:engine/model/operation/insertoperation~InsertOperation|null}
 	 */
 	get _insertOperation() {
 		return this.operations[ 0 ] || null;

+ 3 - 3
packages/ckeditor5-engine/src/model/delta/movedelta.js

@@ -31,7 +31,7 @@ export default class MoveDelta extends Delta {
 	}
 
 	/**
-	 * {@link module:engine/model/delta/delta~Delta.MoveDelta#_moveOperation Move operation}
+	 * {@link module:engine/model/delta/movedelta~MoveDelta#_moveOperation Move operation}
 	 * {@link module:engine/model/operation/moveoperation~MoveOperation#sourcePosition source position} or `null` if there are
 	 * no operations in the delta.
 	 *
@@ -42,7 +42,7 @@ export default class MoveDelta extends Delta {
 	}
 
 	/**
-	 * {@link module:engine/model/delta/delta~Delta.MoveDelta#_moveOperation Move operation}
+	 * {@link module:engine/model/delta/movedelta~MoveDelta#_moveOperation Move operation}
 	 * {@link module:engine/model/operation/moveoperation~MoveOperation#targetPosition target position} or `null` if there are
 	 * no operations in the delta.
 	 *
@@ -53,7 +53,7 @@ export default class MoveDelta extends Delta {
 	}
 
 	/**
-	 * {@link module:engine/model/delta/delta~Delta.MoveDelta#_moveOperation Move operation} that is saved in this delta or `null`
+	 * {@link module:engine/model/delta/movedelta~MoveDelta#_moveOperation Move operation} that is saved in this delta or `null`
 	 * if there are no operations in the delta.
 	 *
 	 * @protected

+ 2 - 2
packages/ckeditor5-engine/src/model/delta/splitdelta.js

@@ -49,10 +49,10 @@ export default class SplitDelta extends Delta {
 	 * Operation in the delta that adds to model an element into which split nodes will be moved, or `null` if
 	 * there are no operations in the delta.
 	 *
-	 * Most commonly this will be {@link module:engine/model/operation/insertoperation~insertOperation an insert operation},
+	 * Most commonly this will be {@link module:engine/model/operation/insertoperation~InsertOperation an insert operation},
 	 * as `SplitDelta` has to create a new node. If `SplitDelta` was created through
 	 * {@link module:engine/model/delta/delta~Delta#getReversed reversing}
-	 * a {@link module:engine/model/delta/delta~Delta.MergeDelta merge delta},
+	 * a {@link module:engine/model/delta/mergedelta~MergeDelta merge delta},
 	 * this will be a {@link module:engine/model/opertation/reinsertoperation~ReinsertOperation reinsert operation},
 	 * as we will want to re-insert the exact element that was removed by that merge delta.
 	 *

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

@@ -34,7 +34,7 @@ export default class WeakInsertDelta extends InsertDelta {
  *
  * * When using `weakInsert`, inserted nodes will have same attributes as the current attributes of
  * {@link module:engine/model/document~Document#selection document selection}.
- * * If {@link module:engine/model/operation/insertoperation~insertOperation insert operation} position is inside a range changed by
+ * * If {@link module:engine/model/operation/insertoperation~InsertOperation insert operation} position is inside a range changed by
  * {@link module:engine/model/operation/attributeoperation~AttributeOperation attribute operation},
  * the attribute operation is split into two operations.
  * Thanks to this, attribute change "omits" the inserted nodes. The correct behavior for `WeakInsertDelta` is that

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

@@ -50,7 +50,7 @@ export default class WrapDelta extends Delta {
 	 * Operation that inserts wrapping element or `null` if there are no operations in the delta.
 	 *
 	 * @protected
-	 * @type {module:engine/model/operation/insertoperation~insertOperation|module:engine/model/opertation/reinsertoperation~ReinsertOperation}
+	 * @type {module:engine/model/operation/insertoperation~InsertOperation|module:engine/model/opertation/reinsertoperation~ReinsertOperation}
 	 */
 	get _insertOperation() {
 		return this.operations[ 0 ] || null;

+ 2 - 2
packages/ckeditor5-engine/src/model/item.jsdoc

@@ -8,7 +8,7 @@
   */
 
 /**
- * Item is a {@link module/engine/model/node~Node Node} or {module/engine/model/textproxy~TextProxy TextProxy}.
+ * Item is a {@link module:engine/model/node~Node Node} or {module:engine/model/textproxy~TextProxy TextProxy}.
  *
- * @typedef {module/engine/model/node~Node|module/engine/model/textproxy~TextProxy} module:engine/model/item~Item
+ * @typedef {module:engine/model/node~Node|module:engine/model/textproxy~TextProxy} module:engine/model/item~Item
  */

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

@@ -36,7 +36,7 @@ export default class InsertOperation extends Operation {
 		 * Position of insertion.
 		 *
 		 * @readonly
-		 * @member {module:engine/model/position~Position} module:engine/model/operation/insertoperation~insertOperation#position
+		 * @member {module:engine/model/position~Position} module:engine/model/operation/insertoperation~InsertOperation#position
 		 */
 		this.position = Position.createFromPosition( position );
 
@@ -44,7 +44,7 @@ export default class InsertOperation extends Operation {
 		 * List of nodes to insert.
 		 *
 		 * @readonly
-		 * @member {module:engine/model/nodelist~NodeList} module:engine/model/operation/insertoperation~insertOperation#nodeList
+		 * @member {module:engine/model/nodelist~NodeList} module:engine/model/operation/insertoperation~InsertOperation#nodeList
 		 */
 		this.nodes = new NodeList( normalizeNodes( nodes ) );
 	}
@@ -58,7 +58,7 @@ export default class InsertOperation extends Operation {
 
 	/**
 	 * @inheritDoc
-	 * @returns {module:engine/model/operation/insertoperation~insertOperation}
+	 * @returns {module:engine/model/operation/insertoperation~InsertOperation}
 	 */
 	clone() {
 		const nodes = new NodeList( [ ...this.nodes ].map( ( node ) => node.clone( true ) ) );
@@ -102,7 +102,7 @@ export default class InsertOperation extends Operation {
 	 *
 	 * @param {Object} json Deserialized JSON object.
 	 * @param {module:engine/model/document~Document} document Document on which this operation will be applied.
-	 * @returns {module:engine/model/operation/insertoperation~insertOperation}
+	 * @returns {module:engine/model/operation/insertoperation~InsertOperation}
 	 */
 	static fromJSON( json, document ) {
 		let children = [];

+ 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/treenode~TextNode text nodes} with same attributes, which means
+ * * model writer API automatically merges {@link module:engine/model/textnode~TextNode text nodes} with same attributes, which means
  * lower memory usage and better efficiency.
  *
  * @namespace writer

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

@@ -22,7 +22,7 @@ import Matcher from './matcher.js';
  * class, {@link module:engine/view/attributeelement~AttributeElement} class or {@link module:engine/view/emptyelement~EmptyElement} class.
  *
  * Note that for view elements which are not created from model, like elements from mutations, paste or
- * {@link engine.controller.DataController#set data.set} it is not possible to define the type of the element, so
+ * {@link module:engine/controller/datacontroller~DataController#set data.set} it is not possible to define the type of the element, so
  * these will be instances of the {@link module:engine/view/element~Element}.
  *
  * @extends module:engine/view/node~Node

+ 2 - 2
packages/ckeditor5-engine/src/view/item.jsdoc

@@ -8,7 +8,7 @@
   */
 
 /**
- * Item is a {@link module/engine/view/node~Node Node} or {module/engine/view/textproxy~TextProxy TextProxy}.
+ * Item is a {@link module:engine/view/node~Node Node} or {module:engine/view/textproxy~TextProxy TextProxy}.
  *
- * @typedef {module/engine/view/node~Node|module/engine/view/textproxy~TextProxy} module:engine/view/item~Item
+ * @typedef {module:engine/view/node~Node|module:engine/view/textproxy~TextProxy} module:engine/view/item~Item
  */

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

@@ -33,13 +33,13 @@ export default class ClickObserver extends DomEventObserver {
 /**
  * Fired when one of the editables has been clicked.
  *
- * Introduced by {@link module:engine/view/observer/observer~Observer.ClickObserver}.
+ * Introduced by {@link module:engine/view/observer/clickobserver~ClickObserver}.
  *
- * Note that this event is not available by default. To make it available {@link
- * module:engine/view/observer/observer~Observer.ClickObserver} needs to be added
+ * Note that this event is not available by default. To make it available
+ * {@link module:engine/view/observer/clickobserver~ClickObserver} needs to be added
  * to {@link module:engine/view/document~Document} by a {@link module:engine/view/document~Document#addObserver} method.
  *
- * @see module:engine/view/observer/observer~Observer.ClickObserver
+ * @see module:engine/view/observer/clickobserver~ClickObserver
  * @event module:engine/view/document~Document#event:click
  * @param {module:engine/view/observer/domeventdata~DomEventData} data Event data.
  */

+ 4 - 4
packages/ckeditor5-engine/src/view/observer/focusobserver.js

@@ -48,8 +48,8 @@ export default class FocusObserver extends DomEventObserver {
  *
  * Introduced by {@link module:engine/view/observer/focusobserver~FocusObserver}.
  *
- * Note that because {@link module:engine/view/observer/focusobserver~FocusObserver} is attached by the {@link
- * module:engine/view/document~Document}
+ * Note that because {@link module:engine/view/observer/focusobserver~FocusObserver} is attached by the
+ * {@link module:engine/view/document~Document}
  * this event is available by default.
  *
  * @see module:engine/view/observer/focusobserver~FocusObserver
@@ -62,8 +62,8 @@ export default class FocusObserver extends DomEventObserver {
  *
  * Introduced by {@link module:engine/view/observer/focusobserver~FocusObserver}.
  *
- * Note that because {@link module:engine/view/observer/focusobserver~FocusObserver} is attached by the {@link
- * module:engine/view/document~Document}
+ * Note that because {@link module:engine/view/observer/focusobserver~FocusObserver} is attached by the
+ * {@link module:engine/view/document~Document}
  * this event is available by default.
  *
  * @see module:engine/view/observer/focusobserver~FocusObserver

+ 4 - 4
packages/ckeditor5-engine/src/view/observer/keyobserver.js

@@ -44,8 +44,8 @@ export default class KeyObserver extends DomEventObserver {
  *
  * Introduced by {@link module:engine/view/observer/keyobserver~KeyObserver}.
  *
- * Note that because {@link module:engine/view/observer/keyobserver~KeyObserver} is attached by the {@link
- * module:engine/view/document~Document}
+ * Note that because {@link module:engine/view/observer/keyobserver~KeyObserver} is attached by the
+ * {@link module:engine/view/document~Document}
  * this event is available by default.
  *
  * @see module:engine/view/observer/keyobserver~KeyObserver
@@ -58,11 +58,11 @@ export default class KeyObserver extends DomEventObserver {
  *
  * @class module:engine/view/observer/keyobserver~KeyObserver.KeyEventData
  * @extends module:engine/view/observer/domeventdata~DomEventData
- * @implements utils.keyboard.KeystrokeData
+ * @implements module:utils/keyboard/keystorkedata~KeystrokeData
  */
 
 /**
- * Code of the whole keystroke. See {@link utils.keyboard.getCode}.
+ * Code of the whole keystroke. See {@link module:utils/keyboard~getCode}.
  *
  * @readonly
  * @member {Number} module:engine/view/observer/keyobserver~KeyObserver.KeyEventData#keystroke

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

@@ -16,7 +16,7 @@ import DomEventObserver from './domeventobserver.js';
  * module:engine/view/document~Document}
  * by {@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 MouseObserver extends DomEventObserver {
 	constructor( document ) {
@@ -33,13 +33,12 @@ export default class MouseObserver extends DomEventObserver {
 /**
  * Fired when mouse button is pressed down on one of the editables.
  *
- * Introduced by {@link module:engine/view/observer/observer~Observer.MouseObserver}.
+ * Introduced by {@link module:engine/view/observer/mouseobserver~MouseObserver}.
  *
- * Note that this event is not available by default. To make it available {@link
- * module:engine/view/observer/observer~Observer.MouseObserver}
+ * Note that this event is not available by default. To make it available {@link module:engine/view/observer/mouseobserver~MouseObserver}
  * needs to be added to {@link module:engine/view/document~Document} by a {@link module:engine/view/document~Document#addObserver} method.
  *
- * @see module:engine/view/observer/observer~Observer.MouseObserver
+ * @see module:engine/view/observer/mouseobserver~MouseObserver
  * @event module:engine/view/document~Document#event:mousedown
  * @param {module:engine/view/observer/domeventdata~DomEventData} data Event data.
  */

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

@@ -239,15 +239,15 @@ export default class MutationObserver extends Observer {
  *
  * Introduced by {@link module:engine/view/observer/mutationobserver~MutationObserver}.
  *
- * Note that because {@link module:engine/view/observer/mutationobserver~MutationObserver} is attached by the {@link
- * module:engine/view/document~Document}
+ * Note that because {@link module:engine/view/observer/mutationobserver~MutationObserver} is attached by the
+ * {@link module:engine/view/document~Document}
  * this event is available by default.
  *
  * @see module:engine/view/observer/mutationobserver~MutationObserver
  * @event module:engine/view/document~Document#event:mutations
  * @param {Array.<module:engine/view/observer/mutationobserver~MutatedText|module:engine/view/observer/mutationobserver~MutatatedChildren>}
  * viewMutations Array of mutations.
- * For mutated texts it will be {@linkmodule:engine/view/observer/mutationobserver~MutatedText} and for mutated elements it will be
+ * For mutated texts it will be {@link module:engine/view/observer/mutationobserver~MutatedText} and for mutated elements it will be
  * {@link module:engine/view/observer/mutationobserver~MutatatedChildren}. You can recognize the type based on the `type` property.
  * @param {module:engine/view/selection~Selection|null} viewSelection View selection that is a result of converting DOM selection to view.
  * Keep in

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

@@ -220,8 +220,8 @@ export default class SelectionObserver extends Observer {
  *
  * Introduced by {@link module:engine/view/observer/selectionobserver~SelectionObserver}.
  *
- * Note that because {@link module:engine/view/observer/selectionobserver~SelectionObserver} is attached by the {@link
- * module:engine/view/document~Document}
+ * Note that because {@link module:engine/view/observer/selectionobserver~SelectionObserver} is attached by the
+ * {@link module:engine/view/document~Document}
  * this event is available by default.
  *
  * @see module:engine/view/observer/selectionobserver~SelectionObserver