Przeglądaj źródła

Docs for changes made to model converters.

Szymon Kupś 8 lat temu
rodzic
commit
85ba5b8508

+ 3 - 6
packages/ckeditor5-engine/src/conversion/model-selection-to-view-converters.js

@@ -164,14 +164,11 @@ export function convertSelectionAttribute( elementCreator ) {
  * Performs similar conversion as {@link ~convertSelectionAttribute}, but depends on a marker name of a marker in which
  * collapsed selection is placed.
  *
- *		modelDispatcher.on( 'selectionMarker:searchResult', wrapRange( new ViewAttributeElement( 'span', { class: 'searchResult' } ) ) );
- *
- * **Note:** You can use the same `elementCreator` function for this converter factory
- * and {@link module:engine/conversion/model-to-view-converters~wrapRange}.
+ *		modelDispatcher.on( 'selectionMarker:searchResult', convertSelectionMarker( { class: 'search' } ) );
  *
  * @see module:engine/conversion/model-selection-to-view-converters~convertSelectionAttribute
- * @param {module:engine/view/attributeelement~AttributeElement|Function} elementCreator View element,
- * or function returning a view element, which will be used for wrapping.
+ * @param {module:engine/conversion/buildmodelconverter~VirtualSelectionDescriptor|Function} selectionDescriptor Virtual
+ * selection descriptor object or function returning a descriptor object.
  * @returns {Function} Selection converter.
  */
 export function convertSelectionMarker( selectionDescriptor ) {

+ 14 - 0
packages/ckeditor5-engine/src/conversion/model-to-view-converters.js

@@ -385,6 +385,13 @@ export function remove() {
 	};
 }
 
+/**
+ * Function factory, crates marker to virtual selection converter.
+ * For more information see {@link module:engine/conversion/buildmodelconverter~ModelConverterBuilder#toVirtualSelection}.
+ *
+ * @param {module:engine/conversion/modelconversiondispatcher~VirtualSelectionDescriptor|Function} selectionDescriptor
+ * @return {Function} Marker to virtual selection converter.
+ */
 export function markerToVirtualSelection( selectionDescriptor ) {
 	return ( evt, data, consumable, conversionApi ) =>	{
 		const descriptor = typeof selectionDescriptor == 'function' ?
@@ -510,6 +517,13 @@ export function eventNameToConsumableType( evtName ) {
 	return parts[ 0 ] + ':' + parts[ 1 ];
 }
 
+/**
+ * Creates `span` {@link module:engine/view/attributeelement~AttributeElement view attribute element} from information
+ * provided by {@link module:engine/conversion/modelconversiondispatcher~VirtualSelectionDescriptor} object.
+ *
+ * @param {module:engine/conversion/modelconversiondispatcher~VirtualSelectionDescriptor }descriptor
+ * @return {module:engine/view/attributeelement~AttributeElement}
+ */
 export function virtualSelectionDescriptorToAttribute( descriptor ) {
 	const attributeElement = new ViewAttributeElement( 'span', descriptor.attributes );