Procházet zdrojové kódy

Improved API docs.

Maciej Bukowski před 6 roky
rodič
revize
44f1d0a76d

+ 1 - 3
packages/ckeditor5-watchdog/src/editorwatchdog.js

@@ -89,9 +89,7 @@ export default class EditorWatchdog extends Watchdog {
 	}
 
 	/**
-	 * Returns the handled instance.
-	 *
-	 * @protected
+	 * @inheritDoc
 	 */
 	get _instance() {
 		return this._editor;

+ 26 - 8
packages/ckeditor5-watchdog/src/watchdog.js

@@ -41,14 +41,6 @@ export default class Watchdog {
 		 */
 		this.crashes = [];
 
-		/**
-		 * TODO
-		 *
-		 * @abstract
-		 * @protected
-		 * @method #_restart
-		 */
-
 		/**
 		 * Specifies the state of the instance handled by the watchdog. The state can be one of the following values:
 		 *
@@ -119,6 +111,32 @@ export default class Watchdog {
 		 * @member {Function} #_destructor
 		 * @see #setDestructor
 		 */
+
+		/**
+		 * The handled instances.
+		 *
+		 * @abstract
+		 * @protected
+		 * @member {Object} #_instance
+		 */
+
+		/**
+		 * The method responsible for the instance restarting.
+		 *
+		 * @abstract
+		 * @protected
+		 * @method #_restart
+		 */
+
+		/**
+		 * Traverses the error context and the handled instance to find out whether the error should
+		 * be handled by the given instance.
+		 *
+		 * @abstract
+		 * @protected
+		 * @method #_isErrorComingFromThisInstance
+		 * @param {module:utils/ckeditorerror~CKEditorError} error
+		 */
 	}
 
 	/**