8
0
Просмотр исходного кода

Documentation: update core.dataprocessor documentation.

Maciej Gołaszewski 9 лет назад
Родитель
Сommit
0aed5042d8

+ 4 - 2
packages/ckeditor5-engine/src/dataprocessor/basichtmlwriter.js

@@ -6,16 +6,18 @@
 'use strict';
 
 /**
+ * @classdesc
  * Basic HTML writer, it uses the native `innerHTML` property for basic conversion
  * from DocumentFragment to an HTML string.
  *
- * @class dataProcessor.BasicHtmlWriter
- * @implements dataProcessor.HtmlWriter
+ * @class core.dataProcessor.BasicHtmlWriter
+ * @implements core.dataProcessor.HtmlWriter
  */
 export default class BasicHtmlWriter {
 	/**
 	 * Returns HTML string created from DocumentFragment.
 	 *
+	 * @method core.dataProcessor.BasicHtmlWriter#getHtml
 	 * @param {DocumentFragment} fragment
 	 * @returns {String}
 	 */

+ 3 - 3
packages/ckeditor5-engine/src/dataprocessor/dataprocessor.js

@@ -8,13 +8,13 @@
  * Each data processor implements a certain format of the data. E.g. `MarkdownDataProcessor` will convert the data
  * (Markdown string) to a DocumentFragment and back.
  *
- * @interface dataProcessor.DataProcessor
+ * @interface core.dataProcessor.DataProcessor
  */
 
 /**
  * Converts a DocumentFragment to data.
  *
- * @method toData
+ * @method core.dataProcessor.DataProcessor#toData
  * @param {DocumentFragment} fragment DocumentFragment to be processed.
  * @returns {*}
  */
@@ -22,7 +22,7 @@
 /**
  * Converts data to a DocumentFragment.
  *
- * @method toDom
+ * @method core.dataProcessor.DataProcessor#toDom
  * @param {*} data Data to be processed.
  * @returns {DocumentFragment}
  */

+ 8 - 9
packages/ckeditor5-engine/src/dataprocessor/htmldataprocessor.js

@@ -8,22 +8,20 @@
 import BasicHtmlWriter from './basichtmlwriter.js';
 
 /**
- * HtmlDataProcessor class.
+ * Creates a new instance of the HtmlDataProcessor class.
+ *
+ * @classdesc HtmlDataProcessor class.
  * This data processor implementation uses HTML as input/output data.
  *
- * @class dataProcessor.HtmlDataProcessor
- * @implements dataProcessor.DataProcessor
+ * @class core.dataProcessor.HtmlDataProcessor
+ * @implements core.dataProcessor.DataProcessor
  */
 export default class HtmlDataProcessor {
-	/**
-	 * Creates a new instance of the HtmlDataProcessor class.
-	 *
-	 * @constructor
-	 */
 	constructor() {
 		/**
 		 * DOMParser instance used to parse HTML string to HTMLDocument.
 		 *
+		 * @member core.dataProcessor.HtmlDataProcessor#_domParser
 		 * @private
 		 * @type {DOMParser}
 		 */
@@ -32,8 +30,9 @@ export default class HtmlDataProcessor {
 		/**
 		 * BasicHtmlWriter instance used to convert DOM elements to HTML string.
 		 *
+		 * @member core.dataProcessor.HtmlDataProcessor#_htmlWriter
 		 * @private
-		 * @type {dataProcessor.BasicHtmlWriter}
+		 * @type {core.dataProcessor.BasicHtmlWriter}
 		 */
 		this._htmlWriter = new BasicHtmlWriter();
 	}

+ 2 - 2
packages/ckeditor5-engine/src/dataprocessor/htmlwriter.js

@@ -6,13 +6,13 @@
 /**
  * HTML writer interface.
  *
- * @interface dataProcessor.HtmlWriter
+ * @interface core.dataProcessor.HtmlWriter
  */
 
 /**
  * Returns HTML string created from DocumentFragment.
  *
- * @method getHtml
+ * @method core.dataProcessor.HtmlWriter#getHtml
  * @param {DocumentFragment} fragment
  * @returns {String}
  */