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

Docs: added missing documentation.

Szymon Cofalik 9 лет назад
Родитель
Сommit
576f286c33

+ 2 - 1
packages/ckeditor5-engine/src/controller/editingcontroller.js

@@ -138,7 +138,8 @@ export default class EditingController {
 	}
 
 	/**
-	 * Removes all event listeners attached by the EditingController.
+	 * Removes all event listeners attached to the `EditingController`. Destroys all objects created
+	 * by `EditingController` that need to be destroyed.
 	 */
 	destroy() {
 		this.view.destroy();

+ 3 - 0
packages/ckeditor5-engine/src/view/document.js

@@ -304,6 +304,9 @@ export default class Document {
 		}
 	}
 
+	/**
+	 * Destroys all observers created by view `Document`.
+	 */
 	destroy() {
 		for ( let observer of this._observers.values() ) {
 			observer.destroy();

+ 3 - 0
packages/ckeditor5-engine/src/view/observer/mutationobserver.js

@@ -112,6 +112,9 @@ export default class MutationObserver extends Observer {
 		this._mutationObserver.disconnect();
 	}
 
+	/**
+	 * @inheritDoc
+	 */
 	destroy() {
 		super.destroy();
 

+ 3 - 0
packages/ckeditor5-engine/src/view/observer/observer.js

@@ -62,6 +62,9 @@ export default class Observer {
 		this.isEnabled = false;
 	}
 
+	/**
+	 * Disables and destroys the observer, among others removes event listeners created by the observer.
+	 */
 	destroy() {
 		this.disable();
 		this.stopListening();

+ 3 - 0
packages/ckeditor5-engine/src/view/observer/selectionobserver.js

@@ -111,6 +111,9 @@ export default class SelectionObserver extends Observer {
 		this._documents.add( domDocument );
 	}
 
+	/**
+	 * @inheritDoc
+	 */
 	destroy() {
 		super.destroy();