瀏覽代碼

API docs fixes.

Maciej Bukowski 7 年之前
父節點
當前提交
2a434eace3

+ 9 - 6
packages/ckeditor5-engine/src/model/markercollection.js

@@ -88,7 +88,8 @@ export default class MarkerCollection {
 	 * @param {String|module:engine/model/markercollection~Marker} markerOrName Name of marker to set or marker instance to update.
 	 * @param {module:engine/model/range~Range} range Marker range.
 	 * @param {Boolean} [managedUsingOperations=false] Specifies whether the marker is managed using operations.
-	 * @param {Boolean} [affectsData=true] Specifies whether the marker changes the data model.
+	 * @param {Boolean} [affectsData=true] Specifies whether the marker affects the data produced by the data pipeline
+	 * (is persisted in the editor's data).
 	 * @returns {module:engine/model/markercollection~Marker} `Marker` instance which was added or updated.
 	 */
 	_set( markerOrName, range, managedUsingOperations = false, affectsData = true ) {
@@ -319,7 +320,8 @@ class Marker {
 	 * @param {String} name Marker name.
 	 * @param {module:engine/model/liverange~LiveRange} liveRange Range marked by the marker.
 	 * @param {Boolean} managedUsingOperations Specifies whether the marker is managed using operations.
-	 * @param {Boolean} affectsData Specifies whether the marker changes the data model.
+	 * @param {Boolean} affectsData Specifies whether the marker affects the data produced by the data pipeline
+	 * (is persisted in the editor's data).
 	 */
 	constructor( name, liveRange, managedUsingOperations, affectsData ) {
 		/**
@@ -339,9 +341,10 @@ class Marker {
 		this._managedUsingOperations = managedUsingOperations;
 
 		/**
-		 * Flag indicates if the marker changes the data model.
+		 * Specifies whether the marker affects the data produced by the data pipeline
+		 * (is persisted in the editor's data).
 		 *
-		 * @protected
+		 * @private
 		 * @member {Boolean}
 		 */
 		this._affectsData = affectsData;
@@ -410,7 +413,7 @@ class Marker {
 	}
 
 	/**
-	 * Returns range that represents current state of marker.
+	 * Returns a range that represents the current state of the marker.
 	 *
 	 * Keep in mind that returned value is a {@link module:engine/model/range~Range Range}, not a
 	 * {@link module:engine/model/liverange~LiveRange LiveRange}. This means that it is up-to-date and relevant only
@@ -430,7 +433,7 @@ class Marker {
 	}
 
 	/**
-	 * Binds new live range to marker and detach the old one if is attached.
+	 * Binds new live range to the marker and detach the old one if is attached.
 	 *
 	 * @protected
 	 * @param {module:engine/model/liverange~LiveRange} liveRange Live range to attach

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

@@ -20,7 +20,8 @@ export default class MarkerOperation extends Operation {
 	 * @param {module:engine/model/range~Range} newRange Marker range after the change.
 	 * @param {module:engine/model/markercollection~MarkerCollection} markers Marker collection on which change should be executed.
 	 * @param {Number|null} baseVersion Document {@link module:engine/model/document~Document#version} on which operation
-	 * @param {Boolean} affectsData Specifies whether the marker operation changes the data model.
+	 * @param {Boolean} affectsData Specifies whether the marker operation affects the data produced by the data pipeline
+	 * (is persisted in the editor's data).
 	 * can be applied or `null` if the operation operates on detached (non-document) tree.
 	 */
 	constructor( name, oldRange, newRange, markers, baseVersion, affectsData ) {
@@ -51,7 +52,8 @@ export default class MarkerOperation extends Operation {
 		this.newRange = newRange ? Range.createFromRange( newRange ) : null;
 
 		/**
-		 * Specifies whether the marker operation changes the data model.
+		 * Specifies whether the marker operation affects the data produced by the data pipeline
+		 * (is persisted in the editor's data).
 		 *
 		 * @readonly
 		 * @member {Boolean}

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

@@ -794,8 +794,8 @@ export default class Writer {
 	 * {@link module:engine/model/markercollection~Marker marker class description} to learn about the difference between
 	 * markers managed by operations and not-managed by operations.
 	 *
-	 * The `options.affectData` parameter, which defaults to true, allows you to create marker, that doesn't affects the data model.
-	 * It impacts on performance, because changes in markers with set `options.affectData:false` don't cause firing the
+	 * The `options.affectData` parameter, which defaults to `true`, allows you to create marker, that does not affects the data model.
+	 * It impacts the performance, because changes in markers with set `options.affectData:false` do not cause firing the
 	 * {@link module:engine/model/document#change:data `change:data`} event.
 	 *
 	 * Create marker directly base on marker's name:
@@ -806,7 +806,7 @@ export default class Writer {
 	 *
 	 *		addMarker( markerName, { range, usingOperation: true } );
 	 *
-	 * Create marker that doesn't affects the data model:
+	 * Create marker that does not affects the data model:
 	 *
 	 *		addMarker( markerName, { range, usingOperation: false, affectData: false } );
 	 *
@@ -878,8 +878,8 @@ export default class Writer {
 	 * {@link module:engine/model/markercollection~Marker marker class description} to learn about the difference between
 	 * markers managed by operations and not-managed by operations. It is possible to change this option for an existing marker.
 	 *
-	 * The `options.affectData` parameter allows you to inform the engine, that this marker doesn't affects the data model.
-	 * It impacts on performance, because changes in markers with set `options.affectData:false` don't cause firing the
+	 * The `options.affectData` parameter allows you to inform the engine, that this marker does not affects the data model.
+	 * It impacts the performance, because changes in markers with set `options.affectData:false` do not cause firing the
 	 * {@link module:engine/model/document#change:data `change:data`} event.
 	 *
 	 * Update marker directly base on marker's name:
@@ -895,7 +895,7 @@ export default class Writer {
 	 *
 	 *		updateMarker( marker, { usingOperation: true } );
 	 *
-	 * Change marker's option (inform engine, that the marker doesn't affect the data model):
+	 * Change marker's option (inform engine, that the marker does not affect the data model):
 	 *
 	 *		updateMarker( markerName, { affectData: false } );
 	 *