浏览代码

Minor API docs polishing.

Piotrek Koszuliński 7 年之前
父节点
当前提交
f92546b960
共有 2 个文件被更改,包括 6 次插入2 次删除
  1. 3 1
      packages/ckeditor5-enter/src/enter.js
  2. 3 1
      packages/ckeditor5-enter/src/shiftenter.js

+ 3 - 1
packages/ckeditor5-enter/src/enter.js

@@ -12,7 +12,9 @@ import EnterCommand from './entercommand';
 import EnterObserver from './enterobserver';
 
 /**
- * The enter plugin. Handles the <kbd>Enter</kbd> key (hard line break) in the editor.
+ * This plugin handles the <kbd>Enter</kbd> key (hard line break) in the editor.
+ *
+ * See also the {@link module:enter/shiftenter~ShiftEnter} plugin.
  *
  * @extends module:core/plugin~Plugin
  */

+ 3 - 1
packages/ckeditor5-enter/src/shiftenter.js

@@ -14,7 +14,9 @@ import { upcastElementToElement } from '@ckeditor/ckeditor5-engine/src/conversio
 import { downcastElementToElement } from '@ckeditor/ckeditor5-engine/src/conversion/downcast-converters';
 
 /**
- * The Shift+Enter plugin. Handles the <kbd>Shift</kbd>+<kbd>Enter</kbd> keys (soft line break) in the editor.
+ * This plugin handles the <kbd>Shift</kbd>+<kbd>Enter</kbd> keystroke (soft line break) in the editor.
+ *
+ * See also the {@link module:enter/enter~Enter} plugin.
  *
  * @extends module:core/plugin~Plugin
  */