8
0
فهرست منبع

Docs: Minor API docs fix. [skip ci]

Piotrek Koszuliński 8 سال پیش
والد
کامیت
c314ae3038

+ 7 - 7
packages/ckeditor5-clipboard/src/clipboard.js

@@ -21,13 +21,13 @@ import HtmlDataProcessor from '@ckeditor/ckeditor5-engine/src/dataprocessor/html
  * The clipboard feature. Currently, it's responsible for intercepting the `paste` and `drop` events and
  * passing the pasted content through the clipboard pipeline.
  *
- * ## Clipboard input pipeline
+ * # Clipboard input pipeline
  *
  * The feature creates the clipboard input pipeline which allows processing clipboard content
  * before it gets inserted into the editor. The pipeline consists of two events on which
  * the features can listen in order to modify or totally override the default behavior.
  *
- * ### On {@link module:engine/view/document~Document#event:paste} and {@link module:engine/view/document~Document#event:drop}
+ * ## On {@link module:engine/view/document~Document#event:paste} and {@link module:engine/view/document~Document#event:drop}
  *
  * The default action is to:
  *
@@ -43,7 +43,7 @@ import HtmlDataProcessor from '@ckeditor/ckeditor5-engine/src/dataprocessor/html
  * data from the clipboard (the {@link module:clipboard/datatransfer~DataTransfer `DataTransfer`}).
  * should plug a listener at this stage.
  *
- * ### On {@link module:engine/view/document~Document#event:clipboardInput}
+ * ## On {@link module:engine/view/document~Document#event:clipboardInput}
  *
  * This action is performed by a low priority listener, so it can be overridden by a normal one.
  *
@@ -55,7 +55,7 @@ import HtmlDataProcessor from '@ckeditor/ckeditor5-engine/src/dataprocessor/html
  *			data.dataTransfer.set( 'text/html', transformedContent );
  *		} );
  *
- * ### On {@link module:clipboard/clipboard~Clipboard#event:inputTransformation}
+ * ## On {@link module:clipboard/clipboard~Clipboard#event:inputTransformation}
  *
  * The default action is to insert the content (`data.content`, represented by a
  * {@link module:engine/view/documentfragment~DocumentFragment}) to an editor if the data is not empty.
@@ -79,12 +79,12 @@ import HtmlDataProcessor from '@ckeditor/ckeditor5-engine/src/dataprocessor/html
  *			}
  *		} );
  *
- * ## Clipboard output pipeline
+ * # Clipboard output pipeline
  *
  * The output pipeline is the equivalent of the input pipeline but for the copy and cut operations.
  * It allows to process the content which will be then put into the clipboard or to override the whole process.
  *
- * ### On {@link module:engine/view/document~Document#event:copy} and {@link module:engine/view/document~Document#event:cut}
+ * ## On {@link module:engine/view/document~Document#event:copy} and {@link module:engine/view/document~Document#event:cut}
  *
  * The default action is to:
  *
@@ -93,7 +93,7 @@ import HtmlDataProcessor from '@ckeditor/ckeditor5-engine/src/dataprocessor/html
  * 3. fire {@link module:engine/view/document~Document#event:clipboardOutput} with a clone of the selected content
  * converted to a {@link module:engine/view/documentfragment~DocumentFragment view document fragment}.
  *
- * ### On {@link module:engine/view/document~Document#event:clipboardOutput}
+ * ## On {@link module:engine/view/document~Document#event:clipboardOutput}
  *
  * The default action is to put the content (`data.content`, represented by a
  * {@link module:engine/view/documentfragment~DocumentFragment}) to the clipboard as HTML. In case of the cut operation,

+ 3 - 2
packages/ckeditor5-clipboard/src/clipboardobserver.js

@@ -42,13 +42,14 @@ export default class ClipboardObserver extends DomEventObserver {
 }
 
 /**
- * Fired with a `dataTransfer`, which comes from the clipboard (was pasted or dropped) and
+ * Fired with a `dataTransfer` which comes from the clipboard (was {@link module:engine/view/document~Document#event:paste pasted}
+ * or {@link module:engine/view/document~Document#event:drop dropped}) and
  * should be processed in order to be inserted into the editor.
  * It's part of the {@link module:clipboard/clipboard~Clipboard "clipboard pipeline"}.
  *
  * @see module:clipboard/clipboardobserver~ClipboardObserver
  * @see module:clipboard/clipboard~Clipboard
- * @event module:engine/view/document~Document#event:input
+ * @event module:engine/view/document~Document#event:clipboardInput
  * @param {Object} data Event data.
  * @param {module:clipboard/datatransfer~DataTransfer} data.dataTransfer Data transfer instance.
  */

+ 2 - 2
packages/ckeditor5-clipboard/src/utils/viewtoplaintext.js

@@ -13,9 +13,9 @@
 const smallPaddingElements = [ 'figcaption', 'li' ];
 
 /**
- * Deeply converts {@link module:engine/model/view/item view item} to plain text.
+ * Converts {@link module:engine/view/item~Item view item} and all of its children to plain text.
  *
- * @param {module:engine/model/view/item} viewItem View item to convert.
+ * @param {module:engine/view/item~Item} viewItem View item to convert.
  * @returns {String} Plain text representation of `viewItem`.
  */
 export default function viewToPlainText( viewItem ) {