8
0
Просмотр исходного кода

Added more docs to ClickObserver.

Oskar Wrobel 9 лет назад
Родитель
Сommit
c832d64972
1 измененных файлов с 15 добавлено и 2 удалено
  1. 15 2
      packages/ckeditor5-engine/src/view/observer/clickobserver.js

+ 15 - 2
packages/ckeditor5-engine/src/view/observer/clickobserver.js

@@ -8,8 +8,8 @@ import DomEventObserver from './domeventobserver.js';
 /**
 /**
  * {@link engine.view.Document#click Click} event observer.
  * {@link engine.view.Document#click Click} event observer.
  *
  *
- * Note that this observer is not attached by the {@link engine.view.Document} and 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.
+ * Note that this observer is not available by default. To make it available it needs to be added to {@link engine.view.Document}
+ * by a {@link engine.view.Document#addObserver} method.
  *
  *
  * @memberOf engine.view.observer
  * @memberOf engine.view.observer
  * @extends engine.view.observer.DomEventObserver
  * @extends engine.view.observer.DomEventObserver
@@ -25,3 +25,16 @@ export default class ClickObserver extends DomEventObserver {
 		this.fire( domEvent.type, domEvent );
 		this.fire( domEvent.type, domEvent );
 	}
 	}
 }
 }
+
+/**
+ * Fired when one of the editables has been clicked.
+ *
+ * Introduced by {@link engine.view.observer.ClickObserver}.
+ *
+ * Note that this event is not available by default. To make it available {@link engine.view.observer.ClickObserver} needs to be added
+ * to {@link engine.view.Document} by a {@link engine.view.Document#addObserver} method.
+ *
+ * @see engine.view.observer.ClickObserver
+ * @event engine.view.Document#click
+ * @param {engine.view.observer.DomEventData} data Event data.
+ */