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

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

@@ -229,8 +229,8 @@ export default class DataController {
 	 * {@link module:engine/view/documentfragment~DocumentFragment view document fragment} converted by the
 	 * {@link #viewToModel view to model converters}.
 	 *
-	 * When marker stamps were converted during conversion process then will be set as DocumentFragment
-	 * {@link module:engine/view/documentfragment~DocumentFragment#markers static markers map}.
+	 * When marker stamps were converted during conversion process then will be set as DocumentFragment's
+	 * {@link module:engine/model/documentfragment~DocumentFragment#markers static markers map}.
 	 *
 	 * @param {module:engine/view/element~Element|module:engine/view/documentfragment~DocumentFragment} viewElementOrFragment
 	 * Element or document fragment which content will be converted.

+ 3 - 3
packages/ckeditor5-engine/src/conversion/buildmodelconverter.js

@@ -287,12 +287,12 @@ class ModelConverterBuilder {
 	 *			}
 	 *
 	 * Creator function provides
-	 * {@link module:engine/conversion/buildmodelconverter~ModelConverterBuilder#StampCreatorData} parameters.
+	 * {@link module:engine/conversion/buildmodelconverter~StampCreatorData} parameters.
 	 *
 	 * See how markers {module:engine/model/buildviewconverter~ViewConverterBuilder#toMarker view -> model serialization}
 	 * works to find out what view element format is the best for you.
 	 *
-	 * @param {String|module:engine/view/element~UIElement|Function} element UIElement created by converter or
+	 * @param {String|module:engine/view/uielement~UIElement|Function} element UIElement created by converter or
 	 * a function that returns view element.
 	 */
 	toStamp( element ) {
@@ -404,7 +404,7 @@ export default function buildModelConverter() {
 }
 
 /**
- * @typedef {StampCreatorData} {module:engine/conversion/buildmodelconverter~ModelConverterBuilder#StampCreatorData}
+ * @typedef StampCreatorData
  * @param {Object} data Additional information about the change.
  * @param {String} data.name Marker name.
  * @param {module:engine/model/range~Range} data.range Marker range.

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

@@ -138,7 +138,7 @@ export default class ViewConversionDispatcher {
 	 * events. See also {@link ~ViewConversionDispatcher#event:element element event}.
 	 * @returns {module:engine/model/documentfragment~DocumentFragment} Model data that is a result of the conversion process
 	 * wrapped in `DocumentFragment`. Converted marker stamps will be set as that document fragment's
-	 * {@link module:engine/view/documentfragment~DocumentFragment#markers static markers map}.
+	 * {@link module:engine/model/documentfragment~DocumentFragment#markers static markers map}.
 	 */
 	convert( viewItem, additionalData = {} ) {
 		this.fire( 'viewCleanup', viewItem );

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

@@ -87,8 +87,8 @@ export default class InsertDelta extends Delta {
 /**
  * Inserts a node or nodes at the given position.
  *
- * When inserted element is a {@link engine/model/documentfragment~DocumentFragment} and has markers its markers will
- * be set to {@link engine/model/document~Document#markers}.
+ * When inserted element is a {@link module:engine/model/documentfragment~DocumentFragment} and has markers its markers will
+ * be set to {@link module:engine/model/document~Document#markers}.
  *
  * @chainable
  * @method module:engine/model/batch~Batch#insert

+ 9 - 8
packages/ckeditor5-engine/src/model/delta/transform.js

@@ -14,7 +14,10 @@ import arrayUtils from '@ckeditor/ckeditor5-utils/src/lib/lodash/array';
 
 const specialCases = new Map();
 
-const deltaTransform = {
+/**
+ * @namespace
+ */
+const transform = {
 	/**
 	 * Transforms given {@link module:engine/model/delta/delta~Delta delta} by another {@link module:engine/model/delta/delta~Delta delta}
 	 * and returns the result of that transformation as an array containing one or more {@link module:engine/model/delta/delta~Delta delta}
@@ -30,7 +33,7 @@ const deltaTransform = {
 	 *
 	 * The function itself looks whether two given delta types have a special case function registered. If so, the deltas are
 	 * transformed using that function. If not,
-	 * {@link module:engine/model/delta/transform~defaultTransform default transformation algorithm} is used.
+	 * {@link module:engine/model/delta/transform~transform.defaultTransform default transformation algorithm} is used.
 	 *
 	 * @param {module:engine/model/delta/delta~Delta} a Delta that will be transformed.
 	 * @param {module:engine/model/delta/delta~Delta} b Delta to transform by.
@@ -41,7 +44,7 @@ const deltaTransform = {
 	 * @returns {Array.<module:engine/model/delta/delta~Delta>} Result of the transformation.
 	 */
 	transform( a, b, isAMoreImportantThanB ) {
-		const transformAlgorithm = deltaTransform.getTransformationCase( a, b ) || deltaTransform.defaultTransform;
+		const transformAlgorithm = transform.getTransformationCase( a, b ) || transform.defaultTransform;
 
 		const transformed = transformAlgorithm( a, b, isAMoreImportantThanB );
 		const baseVersion = arrayUtils.last( b.operations ).baseVersion;
@@ -151,8 +154,6 @@ const deltaTransform = {
 	/**
 	 * Adds a special case callback for given delta classes.
 	 *
-	 * @external module:engine/model/delta/transform~transform
-	 * @function module:engine/model/delta/transform~transform.addTransformationCase
 	 * @param {Function} A Delta constructor which instance will get transformed.
 	 * @param {Function} B Delta constructor which instance will be transformed by.
 	 * @param {Function} resolver A callback that will handle custom special case transformation for instances of given delta classes.
@@ -223,8 +224,8 @@ const deltaTransform = {
 
 				for ( let k = 0; k < deltaA.length; k++ ) {
 					for ( let l = 0; l < deltaB.length; l++ ) {
-						const resultAB = deltaTransform.transform( deltaA[ k ], deltaB[ l ], isAMoreImportantThanB );
-						const resultBA = deltaTransform.transform( deltaB[ l ], deltaA[ k ], !isAMoreImportantThanB );
+						const resultAB = transform.transform( deltaA[ k ], deltaB[ l ], isAMoreImportantThanB );
+						const resultBA = transform.transform( deltaB[ l ], deltaA[ k ], !isAMoreImportantThanB );
 
 						deltaA.splice( k, 1, ...resultAB );
 						k += resultAB.length - 1;
@@ -255,7 +256,7 @@ const deltaTransform = {
 	}
 };
 
-export default deltaTransform;
+export default transform;
 
 // Updates base versions of operations inside deltas (which are the results of delta transformation).
 function updateBaseVersion( baseVersion, deltas ) {