@ckeditor/ckeditor5-engine 34.2.0 → 35.1.0

package/src/dataprocessor/dataprocessor.jsdoc

@@ -1,64 +0,0 @@
-/**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-
-/**
- * @module engine/dataprocessor/dataprocessor
- */
-
-/**
- * The data processor interface. It should be implemented by actual data processors.
- *
- * Each data processor implements a certain format of the data. For example, {@glink features/markdown Markdown data processor}
- * will convert the data (a Markdown string) to a {@link module:engine/view/documentfragment~DocumentFragment document fragment} and back.
- *
- * **Note:** While the CKEditor 5 architecture supports changing the data format, in most scenarios we do recommend sticking to
- * the default format which is HTML (supported by the {@link module:engine/dataprocessor/htmldataprocessor~HtmlDataProcessor}).
- * HTML remains [the best standard for rich-text data](https://medium.com/content-uneditable/a-standard-for-rich-text-data-4b3a507af552).
- *
- * And please do remember – using Markdown [does not automatically make your
- * application/website secure](https://github.com/ckeditor/ckeditor5-markdown-gfm/issues/16#issuecomment-375752994).
- *
- * @interface DataProcessor
- */
-
-/**
- * Converts a {@link module:engine/view/documentfragment~DocumentFragment document fragment} to data.
- *
- * @method #toData
- * @param {module:engine/view/documentfragment~DocumentFragment} fragment The document fragment to be processed.
- * @returns {*}
- */
-
-/**
- * Converts the data to a {@link module:engine/view/documentfragment~DocumentFragment document fragment}.
- *
- * @method #toView
- * @param {*} data The data to be processed.
- * @returns {module:engine/view/documentfragment~DocumentFragment}
- */
-
-/**
- * Registers a {@link module:engine/view/matcher~MatcherPattern} for view elements whose content should be treated as raw data
- * and its content should be converted to a
- * {@link module:engine/view/element~Element#getCustomProperty custom property of a view element} called `"$rawContent"` while
- * converting {@link #toView to view}.
- *
- * @method #registerRawContentMatcher
- * @param {module:engine/view/matcher~MatcherPattern} pattern Pattern matching all view elements whose content should
- * be treated as plain text.
- */
-
-/**
- * If the processor is set to use marked fillers, it will insert `&nbsp;` fillers wrapped in `<span>` elements
- * (`<span data-cke-filler="true">&nbsp;</span>`) instead of regular `&nbsp;` characters.
- *
- * This mode allows for more precise handling of block fillers (so they do not leak into the editor content) but bloats the
- * editor data with additional markup.
- *
- * This mode may be required by some features and will be turned on by them automatically.
- *
- * @method #useFillerType
- * @param {'default'|'marked'} type Whether to use the default or marked `&nbsp;` block fillers.
- */

package/src/model/item.jsdoc

@@ -1,14 +0,0 @@
-/**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-
-/**
- * @module engine/model/item
- */
-
-/**
- * Item is a {@link module:engine/model/node~Node} or {@link module:engine/model/textproxy~TextProxy}.
- *
- * @typedef {module:engine/model/node~Node|module:engine/model/textproxy~TextProxy} module:engine/model/item~Item
- */

package/src/view/elementdefinition.jsdoc

@@ -1,59 +0,0 @@
-/**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-
-/**
- * @module engine/view/elementdefinition
- */
-
-/**
- * A plain object that describes a view element in a way that a concrete, exact view element could be created from that description.
- *
- *		const viewDefinition = {
- *			name: 'h1',
- *			classes: [ 'foo', 'bar' ]
- *		};
- *
- * Above describes a view element:
- *
- *		<h1 class="foo bar"></h1>
- *
- * An example with styles and attributes:
- *
- *      const viewDefinition = {
- *          name: 'span',
- *          styles: {
- *              'font-size': '12px',
- *              'font-weight': 'bold'
- *          },
- *          attributes: {
- *              'data-id': '123'
- *          }
- *      };
- *
- * Describes:
- *
- *      <span style="font-size:12px;font-weight:bold" data-id="123"></span>
- *
- * Elements without attributes can be given simply as a string:
- *
- *		const viewDefinition = 'p';
- *
- * Which will be treated as:
- *
- *		const viewDefinition = {
- *			name: 'p'
- *		};
- *
- * @typedef {String|Object} module:engine/view/elementdefinition~ElementDefinition
- *
- * @property {String} name View element name.
- * @property {String|Array.<String>} [classes] Class name or array of class names to match. Each name can be
- * provided in a form of string.
- * @property {Object} [styles] Object with key-value pairs representing styles. Each object key represents style name.
- * Value under that key must be a string.
- * @property {Object} [attributes] Object with key-value pairs representing attributes. Each object key represents
- * attribute name. Value under that key must be a string.
- * @property {Number} [priority] Element's {@link module:engine/view/attributeelement~AttributeElement#priority priority}.
- */

package/src/view/item.jsdoc

@@ -1,14 +0,0 @@
-/**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-
-/**
- * @module engine/view/item
- */
-
-/**
- * Item is a {@link module:engine/view/node~Node Node} or {@link module:engine/view/textproxy~TextProxy TextProxy}.
- *
- * @typedef {module:engine/view/node~Node|module:engine/view/textproxy~TextProxy} module:engine/view/item~Item
- */