Oskar Wróbel 5 lat temu
rodzic
commit
134ff46398

+ 2 - 2
packages/ckeditor5-core/src/editor/utils/dataapimixin.js

@@ -71,11 +71,11 @@ export default DataApiMixin;
  * the right format for you.
  *
  * @method #getData
- * @param {Object} [options]
+ * @param {Object} [options] Additional configuration for the retrieved data. By default two optional
+ * properties: `rootName` and `trim` are provided. Other properties of this object are specified by various editor features.
  * @param {String} [options.rootName='main'] Root name.
  * @param {String} [options.trim='empty'] Whether returned data should be trimmed. This option is set to `'empty'` by default,
  * which means that whenever editor content is considered empty, an empty string is returned. To turn off trimming
  * use `'none'`. In such cases exact content will be returned (for example `'<p>&nbsp;</p>'` for an empty editor).
- * @param {Object} [options.conversionOptions] Additional, custom configuration passed to the conversion process.
  * @returns {String} Output data.
  */

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

@@ -147,7 +147,7 @@ export default class DataController {
 	 * formatted by the {@link #processor data processor}.
 	 *
 	 * @param {Object} [options] Additional configuration for the retrieved data. `DataController` provides two optional
-	 * properties: `root` and `trim`. Other properties of this object are specified by various editor features.
+	 * properties: `rootName` and `trim`. Other properties of this object are specified by various editor features.
 	 * @param {String} [options.rootName='main'] Root name.
 	 * @param {String} [options.trim='empty'] Whether returned data should be trimmed. This option is set to `empty` by default,
 	 * which means whenever editor content is considered empty, an empty string will be returned. To turn off trimming completely
@@ -224,7 +224,7 @@ export default class DataController {
 
 		this.mapper.bindElements( modelElementOrFragment, viewDocumentFragment );
 
-		// Make additional options available during conversion process through conversionSpi.
+		// Make additional options available during conversion process through `conversionApi`.
 		this.downcastDispatcher.conversionApi.options = options;
 
 		// We have no view controller and rendering to DOM in DataController so view.change() block is not used here.
@@ -240,7 +240,7 @@ export default class DataController {
 			}
 		}
 
-		// Remove options from conversionApi.
+		// Clean `conversionApi`.
 		delete this.downcastDispatcher.conversionApi.options;
 
 		return viewDocumentFragment;

+ 0 - 2
packages/ckeditor5-engine/src/conversion/downcastdispatcher.js

@@ -165,7 +165,6 @@ export default class DowncastDispatcher {
 	 * @fires attribute
 	 * @param {module:engine/model/range~Range} range The inserted range.
 	 * @param {module:engine/view/downcastwriter~DowncastWriter} writer The view writer that should be used to modify the view document.
-	 * {module:engine/conversion/downcastdispatcher~DowncastConversionApi conversion api}. Used only with `dataDowncast` group.
 	 */
 	convertInsert( range, writer ) {
 		this.conversionApi.writer = writer;
@@ -319,7 +318,6 @@ export default class DowncastDispatcher {
 	 * @param {String} markerName Marker name.
 	 * @param {module:engine/model/range~Range} markerRange Marker range.
 	 * @param {module:engine/view/downcastwriter~DowncastWriter} writer View writer that should be used to modify view document.
-	 * {module:engine/conversion/downcastdispatcher~DowncastConversionApi conversion api}. Used only with `dataDowncast` group.
 	 */
 	convertMarkerAdd( markerName, markerRange, writer ) {
 		// Do not convert if range is in graveyard or not in the document (e.g. in DocumentFragment).