8
0
فهرست منبع

Docs: Marked `markerToElement()` and `elementToMarker()` conversion helpers as deprecated.

Szymon Cofalik 5 سال پیش
والد
کامیت
3776b9d3b8

+ 3 - 0
packages/ckeditor5-engine/src/conversion/downcasthelpers.js

@@ -239,6 +239,8 @@ export default class DowncastHelpers extends ConversionHelpers {
 	/**
 	/**
 	 * Model marker to view element conversion helper.
 	 * Model marker to view element conversion helper.
 	 *
 	 *
+	 * **Note**: This method was deprecated. Please use {@link #markerToData} instead.
+	 *
 	 * This conversion results in creating a view element on the boundaries of the converted marker. If the converted marker
 	 * This conversion results in creating a view element on the boundaries of the converted marker. If the converted marker
 	 * is collapsed, only one element is created. For example, model marker set like this: `<paragraph>F[oo b]ar</paragraph>`
 	 * is collapsed, only one element is created. For example, model marker set like this: `<paragraph>F[oo b]ar</paragraph>`
 	 * becomes `<p>F<span data-marker="search"></span>oo b<span data-marker="search"></span>ar</p>` in the view.
 	 * becomes `<p>F<span data-marker="search"></span>oo b<span data-marker="search"></span>ar</p>` in the view.
@@ -287,6 +289,7 @@ export default class DowncastHelpers extends ConversionHelpers {
 	 * See {@link module:engine/conversion/conversion~Conversion#for `conversion.for()`} to learn how to add a converter
 	 * See {@link module:engine/conversion/conversion~Conversion#for `conversion.for()`} to learn how to add a converter
 	 * to the conversion process.
 	 * to the conversion process.
 	 *
 	 *
+	 * @deprecated
 	 * @method #markerToElement
 	 * @method #markerToElement
 	 * @param {Object} config Conversion configuration.
 	 * @param {Object} config Conversion configuration.
 	 * @param {String} config.model The name of the model marker (or model marker group) to convert.
 	 * @param {String} config.model The name of the model marker (or model marker group) to convert.

+ 3 - 0
packages/ckeditor5-engine/src/conversion/upcasthelpers.js

@@ -287,6 +287,8 @@ export default class UpcastHelpers extends ConversionHelpers {
 	/**
 	/**
 	 * View element to model marker conversion helper.
 	 * View element to model marker conversion helper.
 	 *
 	 *
+	 * **Note**: This method was deprecated. Please use {@link #dataToMarker} instead.
+	 *
 	 * This conversion results in creating a model marker. For example, if the marker was stored in a view as an element:
 	 * This conversion results in creating a model marker. For example, if the marker was stored in a view as an element:
 	 * `<p>Fo<span data-marker="comment" data-comment-id="7"></span>o</p><p>B<span data-marker="comment" data-comment-id="7"></span>ar</p>`,
 	 * `<p>Fo<span data-marker="comment" data-comment-id="7"></span>o</p><p>B<span data-marker="comment" data-comment-id="7"></span>ar</p>`,
 	 * after the conversion is done, the marker will be available in
 	 * after the conversion is done, the marker will be available in
@@ -321,6 +323,7 @@ export default class UpcastHelpers extends ConversionHelpers {
 	 * See {@link module:engine/conversion/conversion~Conversion#for `conversion.for()`} to learn how to add a converter
 	 * See {@link module:engine/conversion/conversion~Conversion#for `conversion.for()`} to learn how to add a converter
 	 * to the conversion process.
 	 * to the conversion process.
 	 *
 	 *
+	 * @deprecated
 	 * @method #elementToMarker
 	 * @method #elementToMarker
 	 * @param {Object} config Conversion configuration.
 	 * @param {Object} config Conversion configuration.
 	 * @param {module:engine/view/matcher~MatcherPattern} config.view Pattern matching all view elements which should be converted.
 	 * @param {module:engine/view/matcher~MatcherPattern} config.view Pattern matching all view elements which should be converted.