Parcourir la source

Docs: fixed namespaces.

Maciek il y a 9 ans
Parent
commit
82199d0472

+ 8 - 8
packages/ckeditor5-engine/src/view/observer/domeventobserver.js

@@ -16,8 +16,8 @@ import DomEventData from './domeventdata.js';
  * {@link module:engine/view/observer/observer~Observer#disable disabling} and
  * {@link module:engine/view/observer/observer~Observer#enable re-enabling} events.
  * Child class needs to define
- * {@link module:engine/view/observer/observer~Observer.DomEventObserver#domEventType DOM event type} and
- * {@link module:engine/view/observer/observer~Observer.DomEventObserver#onDomEvent callback}.
+ * {@link module:engine/view/observer/domeventobserver~DomEventObserver#domEventType DOM event type} and
+ * {@link module:engine/view/observer/domeventobserver~DomEventObserver#onDomEvent callback}.
  *
  * For instance:
  *
@@ -32,7 +32,7 @@ import DomEventData from './domeventdata.js';
  *			}
  *		}
  *
- * @extends module:engine/view/observer/observer~Observer.Observer
+ * @extends module:engine/view/observer/observer~Observer
  */
 export default class DomEventObserver extends Observer {
 	/**
@@ -40,16 +40,16 @@ export default class DomEventObserver extends Observer {
 	 * if the obsever should listen to multiple DOM events.
 	 *
 	 * @readonly
-	 * @member {String|Array.<String>} module:engine/view/observer/observer~Observer.DomEventObserver#domEventType
+	 * @member {String|Array.<String>} #domEventType
 	 */
 
 	/**
 	 * Callback which should be called when the DOM event occurred. Note that the callback will not be called if
-	 * observer {@link module:engine/view/observer/observer~Observer.DomEventObserver#isEnabled is not enabled}.
+	 * observer {@link #isEnabled is not enabled}.
 	 *
-	 * @see module:engine/view/observer/observer~Observer.DomEventObserver#domEventType
+	 * @see #domEventType
 	 * @abstract
-	 * @method module:engine/view/observer/observer~Observer.DomEventObserver#onDomEvent
+	 * @method #onDomEvent
 	 */
 
 	/**
@@ -69,7 +69,7 @@ export default class DomEventObserver extends Observer {
 
 	/**
 	 * Calls {@link module:engine/view/document~Document#fire} if observer
-	 * {@link module:engine/view/observer/observer~Observer.DomEventObserver#isEnabled is enabled}.
+	 * {@link #isEnabled is enabled}.
 	 *
 	 * @see module:engine/view/document~Document#fire
 	 * @param {String} eventType The event type (name).

+ 1 - 1
packages/ckeditor5-engine/src/view/observer/focusobserver.js

@@ -17,7 +17,7 @@ import DomEventObserver from './domeventobserver.js';
  *
  * Note that this observer is attached by the {@link module:engine/view/document~Document} and is available by default.
  *
- * @extends module:engine/view/observer/observer~Observer.DomEventObserver
+ * @extends module:engine/view/observer/domeventobserver~DomEventObserver
  */
 export default class FocusObserver extends DomEventObserver {
 	constructor( document ) {

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

@@ -15,7 +15,7 @@ import { getCode } from '../../../utils/keyboard.js';
  *
  * Note that this observer is attached by the {@link module:engine/view/document~Document} and is available by default.
  *
- * @extends module:engine/view/observer/observer~Observer.DomEventObserver
+ * @extends module:engine/view/observer/domeventobserver~DomEventObserver
  */
 export default class KeyObserver extends DomEventObserver {
 	constructor( document ) {

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

@@ -28,7 +28,7 @@ export default class Observer {
 		 * Reference to the {@link module:engine/view/document~Document} object.
 		 *
 		 * @readonly
-		 * @member {module:engine/view/document~Document} module:engine/view/observer/observer~Observer#document
+		 * @member {module:engine/view/document~Document}
 		 */
 		this.document = document;
 
@@ -36,7 +36,7 @@ export default class Observer {
 		 * State of the observer. If it is disabled events will not be fired.
 		 *
 		 * @readonly
-		 * @member {Boolean} module:engine/view/observer/observer~Observer#isEnabled
+		 * @member {Boolean}
 		 */
 		this.isEnabled = false;
 	}
@@ -44,7 +44,7 @@ export default class Observer {
 	/**
 	 * Enables the observer. This method is called when then observer is registered to the
 	 * {@link module:engine/view/document~Document} and after {@link module:engine/view/document~Document#render rendering}
-	 * (all observers are {@link module:engine/view/observer/observer~Observer#disable disabled} before rendering).
+	 * (all observers are {@link #disable disabled} before rendering).
 	 *
 	 * A typical use case for disabling observers is that mutation observers need to be disabled for the rendering.
 	 * However, a child class may not need to be disabled, so it can implement an empty method.