Skip to content
This repository has been archived by the owner on Jun 26, 2020. It is now read-only.

Removed nonexistent consumable parameter in the DowncastDispatcher#selection event #1778

Merged
merged 3 commits into from
Aug 9, 2019
Merged

Removed nonexistent consumable parameter in the DowncastDispatcher#selection event #1778

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
18bdbd7
Docs: Removed nonexisting `consumable` parameter in DowncastDispatche…
mlewand Aug 8, 2019
8cda2e9
Remove non-existing consumable parameter from DowncastDispatcher even…
jodator Aug 9, 2019
68d72bd
Update addMarker event docs.
jodator Aug 9, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 3 additions & 6 deletions src/conversion/downcastdispatcher.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -532,7 +532,6 @@ export default class DowncastDispatcher {
* @param {String} data.attributeKey Attribute key.
* @param {*} data.attributeOldValue Attribute value before the change. This is `null` when selection attribute is converted.
* @param {*} data.attributeNewValue New attribute value.
* @param {module:engine/conversion/modelconsumable~ModelConsumable} consumable Values to consume.
* @param {module:engine/conversion/downcastdispatcher~DowncastConversionApi} conversionApi Conversion interface
* to be used by callback, passed in `DowncastDispatcher` constructor.
*/
Expand All @@ -542,7 +541,6 @@ export default class DowncastDispatcher {
*
* @event selection
* @param {module:engine/model/selection~Selection} selection Selection that is converted.
* @param {module:engine/conversion/modelconsumable~ModelConsumable} consumable Values to consume.
* @param {module:engine/conversion/downcastdispatcher~DowncastConversionApi} conversionApi Conversion interface
* to be used by callback, passed in `DowncastDispatcher` constructor.
*/
Expand All @@ -558,17 +556,17 @@ export default class DowncastDispatcher {
* If the marker range is not collapsed:
*
* * the event is fired for each item in the marker range one by one,
* * consumables object includes each item of the marker range and the consumable value is same as event name.
* * `conversionApi.consumable` includes each item of the marker range and the consumable value is same as event name.
*
* If the marker range is collapsed:
*
* * there is only one event,
* * consumables object includes marker range with event name.
* * `conversionApi.consumable` includes marker range with event name.
*
* If selection inside a marker is converted:
*
* * there is only one event,
* * consumables object includes selection instance with event name.
* * `conversionApi.consumable` includes selection instance with event name.
*
* @event addMarker
* @param {Object} data Additional information about the change.
Expand All @@ -578,7 +576,6 @@ export default class DowncastDispatcher {
* the marker range was not collapsed.
* @param {module:engine/model/range~Range} data.markerRange Marker range.
* @param {String} data.markerName Marker name.
* @param {module:engine/conversion/modelconsumable~ModelConsumable} consumable Values to consume.
* @param {module:engine/conversion/downcastdispatcher~DowncastConversionApi} conversionApi Conversion interface
* to be used by callback, passed in `DowncastDispatcher` constructor.
*/
Expand Down