Przeglądaj źródła

Added docs to Image feature and MouseDownObserver.

Szymon Kupś 9 lat temu
rodzic
commit
ffbcf533d5

+ 11 - 0
packages/ckeditor5-image/src/image.js

@@ -8,6 +8,14 @@ import ImageEngine from './imageengine.js';
 import ModelRange from '../engine/model/range.js';
 import MouseDownObserver from './mousedownobserver.js';
 
+/**
+ * The image feature.
+ *
+ * Uses {@link image.ImageEngine}.
+ *
+ * @memberOf image
+ * @extends core.Feature
+ */
 export default class Image extends Feature {
 	/**
 	 * @inheritDoc
@@ -16,6 +24,9 @@ export default class Image extends Feature {
 		return [ ImageEngine ];
 	}
 
+	/**
+	 * @inheritDoc
+	 */
 	init() {
 		const viewDocument = this.editor.editing.view;
 

+ 22 - 0
packages/ckeditor5-image/src/mousedownobserver.js

@@ -5,6 +5,15 @@
 
 import DomEventObserver from '../engine/view/observer/domeventobserver.js';
 
+/**
+ * {@link engine.view.Document#mousedown} event observer.
+ *
+ * Note that this observer is not available by default. To make it available it needs to be added to {@link engine.view.Document}
+ * by {@link engine.view.Document#addObserver} method.
+ *
+ * @memberOf image
+ * @extends engine.view.observer.DomEventObserver
+ */
 export default class MouseDownObserver extends DomEventObserver {
 	constructor( document ) {
 		super( document );
@@ -16,3 +25,16 @@ export default class MouseDownObserver extends DomEventObserver {
 		this.fire( domEvent.type, domEvent );
 	}
 }
+
+/**
+ * Fired when mouse button is pressed down on one of the editables.
+ *
+ * Introduced by {@link image.MouseDownObserver}.
+ *
+ * Note that this event is not available by default. To make it available {@link image.MouseDownObserver} needs to be added
+ * to {@link engine.view.Document} by a {@link engine.view.Document#addObserver} method.
+ *
+ * @see image.MouseDownObserver
+ * @event engine.view.Document#click
+ * @param {engine.view.observer.DomEventData} data Event data.
+ */