Bladeren bron

Docs: Update ViewElementDefinition description.

Maciej Gołaszewski 8 jaren geleden
bovenliggende
commit
c98d8aaf68

+ 2 - 2
packages/ckeditor5-engine/src/conversion/definition-based-converters.js

@@ -294,7 +294,7 @@ function definitionToPattern( viewDefinition ) {
 }
 
 /**
- * Defines conversion details. It is used bt configuration based converters:
+ * Defines conversion details. It is used in configuration based converters:
  * - {@link module:engine/conversion/definition-based-converters~modelAttributeToViewAttributeElement}
  * - {@link module:engine/conversion/definition-based-converters~modelElementToViewContainerElement}
  * - {@link module:engine/conversion/definition-based-converters~viewToModelAttribute}
@@ -308,7 +308,7 @@ function definitionToPattern( viewDefinition ) {
  * ({@link module:engine/conversion/definition-based-converters~viewToModelAttribute}
  * and {@link module:engine/conversion/definition-based-converters~modelAttributeToViewAttributeElement})
  * it defines attribute value to which it is converted.
- * @property {String|module:engine/view/viewelementdefinition~ViewElementDefinition} view Defines model to view conversion and is also used
+ * @property {module:engine/view/viewelementdefinition~ViewElementDefinition} view Defines model to view conversion and is also used
  * in view to model conversion pipeline.
  * @property {Array.<module:engine/view/viewelementdefinition~ViewElementDefinition>} acceptAlso An array with all matched elements that
  * view to model conversion should also accepts.

+ 24 - 2
packages/ckeditor5-engine/src/view/viewelementdefinition.jsdoc

@@ -8,9 +8,31 @@
  */
 
 /**
- * An object defining view element used for defining elements for conversion.
+ * An object defining view element used in {@link module:engine/conversion/definition-based-converters} as part of
+ * {@link module:engine/conversion/definition-based-converters~ConverterDefinition}.
  *
- * @typedef {Object} module:engine/view/viewelementdefinition~ViewElementDefinition
+ * It describe a view element that is used
+ *
+ *		const viewDefinition = {
+ *			name: 'h1',
+ *			classes: [ 'foo', 'bar' ]
+ *		};
+ *
+ * Above describes a view element:
+ *
+ *		<h1 class="foo bar">...</h1>
+ *
+ * For elements without attributes you can use shorthand string version:
+ *
+ *		const viewDefinition = 'p';
+ *
+ * which will be treated as:
+ *
+ *		const viewDefinition = {
+ *			name: 'p'
+ *		};
+ *
+ * @typedef {String|Object} module:engine/view/viewelementdefinition~ViewElementDefinition
  *
  * @property {String} name View element name.
  * @property {String|Array.<String>} [classes] Class name or array of class names to match. Each name can be