Explorar o código

Improved docs.

Oskar Wróbel %!s(int64=8) %!d(string=hai) anos
pai
achega
05b54ce833

+ 8 - 3
packages/ckeditor5-engine/src/conversion/buildmodelconverter.js

@@ -263,17 +263,22 @@ class ModelConverterBuilder {
 	 * will be used. Keep in mind that when you provide view element instance or creator function, it has to be/return a
 	 * proper type of view element: {@link module:engine/view/uielement~UIElement UIElement}.
 	 *
-	 *		buildModelConverter().for( dispatcher ).fromMarker( 'comment' ).toStamp( 'span' );
+	 *		buildModelConverter().for( dispatcher ).fromMarker( 'search' ).toStamp( 'span' );
 	 *
-	 *		buildModelConverter().for( dispatcher ).fromMarker( 'comment' ).toStamp( new UIElement( 'span' ) );
+	 *		buildModelConverter().for( dispatcher )
+	 *			.fromMarker( 'search' )
+	 *			.toStamp( new UIElement( 'span', { 'data-name': 'search' } ) );
 	 *
 	 *		buildModelConverter().for( dispatcher )
-	 *			.fromMarker( 'comment' )
+	 *			.fromMarker( 'search' )
 	 *			.toStamp( ( data ) => new UIElement( 'span', { 'data-name': data.marker.getName() ) );
 	 *
 	 * Creator function provides
 	 * {@link module:engine/conversion/modelconversiondispatcher~ModelConversionDispatcher#event:insert insert event} parameters.
 	 *
+	 * See how markers {module:engine/model/buildviewconverter~ViewConverterBuilder#toMarker view -> model serialization}
+	 * works to find out what view element format is the best for you.
+	 *
 	 * @param {String|module:engine/view/element~UIElement|Function} element UIElement created by converter or
 	 * a function that returns view element.
 	 */

+ 3 - 1
packages/ckeditor5-engine/src/conversion/buildviewconverter.js

@@ -370,6 +370,7 @@ class ViewConverterBuilder {
 	 * 		{ name: '$marker', attribute: { data-name: /^\w/ } }
 	 *
 	 * There are two ways of creating this element:
+	 *
 	 * 1. Makes sure that converted view element will have property `data-name` then converter will
 	 * automatically take this property value. In this case there is no need to provide creator function.
 	 * For the following view:
@@ -381,11 +382,12 @@ class ViewConverterBuilder {
 	 *		buildViewConverter().for( dispatcher ).fromElement( 'marker' ).toMarker();
 	 *
 	 * 2. Creates element by creator:
+	 *
 	 * For the following view:
 	 *
 	 * 		<span foo="search"></span>foo<span foo="search"></span>
 	 *
-	 * converter should looks like this:
+	 * converter should look like this:
 	 *
 	 * 		buildViewConverter().for( dispatcher ).from( { name: 'span', { attribute: foo: /^\w/ } } ).toMarker( ( data ) => {
 	 * 			return new Element( '$marker', { 'data-name': data.getAttribute( 'foo' ) } );