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

Fixed invalid docs which I introduced in the previous commit.

Kamil Piechaczek 8 лет назад
Родитель
Сommit
97f99af854
1 измененных файлов с 12 добавлено и 6 удалено
  1. 12 6
      packages/ckeditor5-engine/src/view/observer/keyobserver.js

+ 12 - 6
packages/ckeditor5-engine/src/view/observer/keyobserver.js

@@ -50,20 +50,26 @@ export default class KeyObserver extends DomEventObserver {
  *
  * @see module:engine/view/observer/keyobserver~KeyObserver
  * @event module:engine/view/document~Document#event:keydown
- * @event module:engine/view/document~Document#event:keyup
  * @param {module:engine/view/observer/keyobserver~KeyEventData} keyEventData
  */
 
 /**
- * The value of the {@link module:engine/view/document~Document#event:keydown} event.
+ * Fired when a key has been released.
  *
- * @class module:engine/view/observer/keyobserver~KeyEventData
- * @extends module:engine/view/observer/domeventdata~DomEventData
- * @implements module:utils/keyboard~KeystrokeInfo
+ * Introduced by {@link module:engine/view/observer/keyobserver~KeyObserver}.
+ *
+ * Note that because {@link module:engine/view/observer/keyobserver~KeyObserver} is attached by the
+ * {@link module:engine/view/document~Document}
+ * this event is available by default.
+ *
+ * @see module:engine/view/observer/keyobserver~KeyObserver
+ * @event module:engine/view/document~Document#event:keyup
+ * @param {module:engine/view/observer/keyobserver~KeyEventData} keyEventData
  */
 
 /**
- * The value of the {@link module:engine/view/document~Document#event:keyup} event.
+ * The value of both events - {@link module:engine/view/document~Document#event:keydown} and
+ * {@link module:engine/view/document~Document#event:keyup}.
  *
  * @class module:engine/view/observer/keyobserver~KeyEventData
  * @extends module:engine/view/observer/domeventdata~DomEventData