浏览代码

API docs improvements.

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

+ 4 - 2
packages/ckeditor5-list/src/list.js

@@ -11,8 +11,10 @@ import Model from '../ui/model.js';
 import { parseKeystroke } from '../utils/keyboard.js';
 
 /**
- * The list feature. It introduces the numbered and bulleted list buttons and the command that allows
- * to convert paragraphs to/from list items and indent/outdent them.
+ * The lists feature. It introduces the `numberedList` and `bulletedList` buttons which
+ * allows to convert paragraphs to/from list items and indent/outdent them.
+ *
+ * See also {@link list.ListEngine}.
  *
  * @memberOf list
  * @extends core.Feature

+ 2 - 1
packages/ckeditor5-list/src/listengine.js

@@ -22,7 +22,8 @@ import {
 } from './converters.js';
 
 /**
- * The engine of list feature. It handles making, editing and removing lists and list items.
+ * The engine of the lists feature. It handles creating, editing and removing lists and list items.
+ * It registers the `numberedList`, `bulletedList`, `indentList` and `outdentList` commands.
  *
  * @memberOf list
  * @extends core.Feature