Browse Source

API docs fixes.

Maciek 9 years ago
parent
commit
fc671f810a

+ 5 - 2
packages/ckeditor5-enter/src/enter.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module enter/enter
+ */
+
 import Plugin from '../core/plugin.js';
 import EnterCommand from './entercommand.js';
 import EnterObserver from './enterobserver.js';
@@ -10,8 +14,7 @@ import EnterObserver from './enterobserver.js';
 /**
  * The Enter feature. Handles the <kbd>Enter</kbd> and <kbd>Shift + Enter</kbd> keys in the editor.
  *
- * @memberOf enter
- * @extends core.Plugin
+ * @extends module:core/plugin~Plugin
  */
 export default class Enter extends Plugin {
 	init() {

+ 5 - 2
packages/ckeditor5-enter/src/entercommand.js

@@ -3,14 +3,17 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module enter/entercommand
+ */
+
 import Command from '../core/command/command.js';
 import Position from '../engine/model/position.js';
 
 /**
  * Enter command. It is used by the {@link enter.Enter Enter feature} to handle the <kbd>Enter</kbd> key.
  *
- * @member enter
- * @extends core.command.Command
+ * @extends modue:core/command/command~Command
  */
 export default class EnterCommand extends Command {
 	/**

+ 8 - 5
packages/ckeditor5-enter/src/enterobserver.js

@@ -3,15 +3,18 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module enter/enterobserver
+ */
+
 import Observer from '../engine/view/observer/observer.js';
 import DomEventData from '../engine/view/observer/domeventdata.js';
 import { keyCodes } from '../utils/keyboard.js';
 
 /**
- * Enter observer introduces the {@link engine.view.Document#enter} event.
+ * Enter observer introduces the {@link module:engine/view/document~Document#enter} event.
  *
- * @memberOf enter
- * @extends engine.view.observer.Observer
+ * @extends module:engine/view/observer~Observer
  */
 export default class EnterObserver extends Observer {
 	constructor( document ) {
@@ -36,6 +39,6 @@ export default class EnterObserver extends Observer {
  * Note: This event is fired by the {@link enter.EnterObserver observer}
  * (usually registered by the {@link enter.Enter Enter feature}).
  *
- * @event engine.view.Document#enter
- * @param {engine.view.observer.DomEventData} data
+ * @event module:engine/view/document~Document#event:enter
+ * @param {module:engine/view/observer/domeventdata~DomEventData} data
  */