Răsfoiți Sursa

Added comments.

Szymon Kupś 9 ani în urmă
părinte
comite
8d5289e1ff

+ 18 - 4
packages/ckeditor5-markdown-gfm/src/gfmdataprocessor.js

@@ -9,11 +9,19 @@ import HtmlDataProcessor from '../engine/dataprocessor/htmldataprocessor.js';
 import GFMRenderer from './lib/marked/renderer.js';
 import converters from './lib/to-markdown/converters.js';
 
+/**
+ * GFMDataProcessor class.
+ * This data processor implementation uses GitHub flavored markdown as input/output data.
+ *
+ * @extends engine.dataProcessor.HtmlDataProcessor
+ */
 export default class GFMDataProcessor extends HtmlDataProcessor {
-	constructor() {
-		super();
-	}
-
+	/**
+	 * Converts provided markdown string to view tree.
+	 *
+	 * @param {String} data Markdown string.
+	 * @returns {engine.view.DocumentFragment} Converted view element.
+	 */
 	toView( data ) {
 		const html = marked.parse( data, {
 			gfm: true,
@@ -26,6 +34,12 @@ export default class GFMDataProcessor extends HtmlDataProcessor {
 		return super.toView( html );
 	}
 
+	/**
+	 * Converts provided {@link engine.view.DocumentFragment DocumentFragment} to data format - in this case markdown string.
+	 *
+	 * @param {engine.view.DocumentFragment} viewFragment
+	 * @returns {String} Markdown string.
+	 */
 	toData( viewFragment ) {
 		const html = super.toData( viewFragment );
 

+ 10 - 2
packages/ckeditor5-markdown-gfm/tests/_utils/utils.js

@@ -1,7 +1,15 @@
 import { stringify } from '/tests/engine/_utils/view.js';
 import MarkdownDataProcessor from '/ckeditor5/markdown-gfm/gfmdataprocessor.js';
 
-export function testDataProcessor( markdown, viewString, normalizedMd ) {
+/**
+ * Tests MarkdownDataProcessor.
+ *
+ * @param {String} markdown Markdown to be processed to view.
+ * @param {String} viewString Expected view structure.
+ * @param {String} [normalizedMarkdown] When converting back to the markdown it might be different than provided input
+ * markdown string (which will be used if this parameter is not provided).
+ */
+export function testDataProcessor( markdown, viewString, normalizedMarkdown ) {
 	const dataProcessor = new MarkdownDataProcessor();
 	const viewFragment = dataProcessor.toView( markdown );
 
@@ -9,7 +17,7 @@ export function testDataProcessor( markdown, viewString, normalizedMd ) {
 	expect( stringify( viewFragment ) ).to.equal( viewString );
 
 	// Check if converting back gives the same result.
-	const normalized = typeof normalizedMd !== 'undefined' ? normalizedMd : markdown;
+	const normalized = typeof normalizedMarkdown !== 'undefined' ? normalizedMarkdown : markdown;
 
 	expect( dataProcessor.toData( viewFragment ) ).to.equal( normalized );
 }