Explorar o código

Docs: Corrected `view.Writer` to `view.DowncastWriter`.

Szymon Cofalik %!s(int64=7) %!d(string=hai) anos
pai
achega
b7f17d498f

+ 3 - 3
packages/ckeditor5-widget/src/highlightstack.js

@@ -34,7 +34,7 @@ export default class HighlightStack {
 	 *
 	 *
 	 * @fires change:top
 	 * @fires change:top
 	 * @param {module:engine/conversion/downcast-converters~HighlightDescriptor} descriptor
 	 * @param {module:engine/conversion/downcast-converters~HighlightDescriptor} descriptor
-	 * @param {module:engine/view/writer~Writer} writer
+	 * @param {module:engine/view/downcastwriter~DowncastWriter} writer
 	 */
 	 */
 	add( descriptor, writer ) {
 	add( descriptor, writer ) {
 		const stack = this._stack;
 		const stack = this._stack;
@@ -59,7 +59,7 @@ export default class HighlightStack {
 	 *
 	 *
 	 * @fires change:top
 	 * @fires change:top
 	 * @param {String} id Id of the descriptor to remove.
 	 * @param {String} id Id of the descriptor to remove.
-	 * @param {module:engine/view/writer~Writer} writer
+	 * @param {module:engine/view/downcastwriter~DowncastWriter} writer
 	 */
 	 */
 	remove( id, writer ) {
 	remove( id, writer ) {
 		const stack = this._stack;
 		const stack = this._stack;
@@ -172,5 +172,5 @@ function classesToString( classes ) {
  * descriptor. It will be `undefined` when last descriptor is removed from the stack.
  * descriptor. It will be `undefined` when last descriptor is removed from the stack.
  * @param {module:engine/conversion/downcast-converters~HighlightDescriptor} [data.oldDescriptor] Old highlight
  * @param {module:engine/conversion/downcast-converters~HighlightDescriptor} [data.oldDescriptor] Old highlight
  * descriptor. It will be `undefined` when first descriptor is added to the stack.
  * descriptor. It will be `undefined` when first descriptor is added to the stack.
- * @param {module:engine/view/writer~Writer} writer View writer that can be used to modify element.
+ * @param {module:engine/view/downcastwriter~DowncastWriter} writer View writer that can be used to modify element.
  */
  */

+ 5 - 5
packages/ckeditor5-widget/src/utils.js

@@ -50,7 +50,7 @@ export function isWidget( element ) {
  * * implements `addHighlight` and `removeHighlight` custom properties to handle view highlight on widgets.
  * * implements `addHighlight` and `removeHighlight` custom properties to handle view highlight on widgets.
  *
  *
  * @param {module:engine/view/element~Element} element
  * @param {module:engine/view/element~Element} element
- * @param {module:engine/view/writer~Writer} writer
+ * @param {module:engine/view/downcastwriter~DowncastWriter} writer
  * @param {Object} [options={}]
  * @param {Object} [options={}]
  * @param {String|Function} [options.label] Element's label provided to {@link ~setLabel} function. It can be passed as
  * @param {String|Function} [options.label] Element's label provided to {@link ~setLabel} function. It can be passed as
  * a plain string or a function returning a string.
  * a plain string or a function returning a string.
@@ -96,7 +96,7 @@ export function toWidget( element, writer, options = {} ) {
  * properly determine which highlight descriptor should be used at given time.
  * properly determine which highlight descriptor should be used at given time.
  *
  *
  * @param {module:engine/view/element~Element} element
  * @param {module:engine/view/element~Element} element
- * @param {module:engine/view/writer~Writer} writer
+ * @param {module:engine/view/downcastwriter~DowncastWriter} writer
  * @param {Function} add
  * @param {Function} add
  * @param {Function} remove
  * @param {Function} remove
  */
  */
@@ -124,7 +124,7 @@ export function setHighlightHandling( element, writer, add, remove ) {
  *
  *
  * @param {module:engine/view/element~Element} element
  * @param {module:engine/view/element~Element} element
  * @param {String|Function} labelOrCreator
  * @param {String|Function} labelOrCreator
- * @param {module:engine/view/writer~Writer} writer
+ * @param {module:engine/view/downcastwriter~DowncastWriter} writer
  */
  */
 export function setLabel( element, labelOrCreator, writer ) {
 export function setLabel( element, labelOrCreator, writer ) {
 	writer.setCustomProperty( labelSymbol, labelOrCreator, element );
 	writer.setCustomProperty( labelSymbol, labelOrCreator, element );
@@ -154,7 +154,7 @@ export function getLabel( element ) {
  * * adds `ck-editor__nested-editable_focused` CSS class when editable is focused and removes it when it's blurred.
  * * adds `ck-editor__nested-editable_focused` CSS class when editable is focused and removes it when it's blurred.
  *
  *
  * @param {module:engine/view/editableelement~EditableElement} editable
  * @param {module:engine/view/editableelement~EditableElement} editable
- * @param {module:engine/view/writer~Writer} writer
+ * @param {module:engine/view/downcastwriter~DowncastWriter} writer
  * @returns {module:engine/view/editableelement~EditableElement} Returns same element that was provided in `editable` param.
  * @returns {module:engine/view/editableelement~EditableElement} Returns same element that was provided in `editable` param.
  */
  */
 export function toWidgetEditable( editable, writer ) {
 export function toWidgetEditable( editable, writer ) {
@@ -193,7 +193,7 @@ function getFillerOffset() {
 // Adds a drag handler to the editable element.
 // Adds a drag handler to the editable element.
 //
 //
 // @param {module:engine/view/editableelement~EditableElement}
 // @param {module:engine/view/editableelement~EditableElement}
-// @param {module:engine/view/writer~Writer} writer
+// @param {module:engine/view/downcastwriter~DowncastWriter} writer
 function addSelectionHandler( editable, writer ) {
 function addSelectionHandler( editable, writer ) {
 	const selectionHandler = writer.createUIElement( 'div', { class: 'ck ck-widget__selection-handler' }, function( domDocument ) {
 	const selectionHandler = writer.createUIElement( 'div', { class: 'ck ck-widget__selection-handler' }, function( domDocument ) {
 		const domElement = this.toDomElement( domDocument );
 		const domElement = this.toDomElement( domDocument );

+ 1 - 1
packages/ckeditor5-widget/src/widget.js

@@ -374,7 +374,7 @@ export default class Widget extends Plugin {
 	 * Removes CSS class from previously selected widgets.
 	 * Removes CSS class from previously selected widgets.
 	 *
 	 *
 	 * @private
 	 * @private
-	 * @param {module:engine/view/writer~Writer} writer
+	 * @param {module:engine/view/downcastwriter~DowncastWriter} writer
 	 */
 	 */
 	_clearPreviouslySelectedWidgets( writer ) {
 	_clearPreviouslySelectedWidgets( writer ) {
 		for ( const widget of this._previouslySelected ) {
 		for ( const widget of this._previouslySelected ) {