Преглед на файлове

Docs: Update to-do list commands docs.

Maciej Gołaszewski преди 5 години
родител
ревизия
4e792a9970
променени са 2 файла, в които са добавени 9 реда и са изтрити 1 реда
  1. 5 0
      packages/ckeditor5-list/src/todolistcheckcommand.js
  2. 4 1
      packages/ckeditor5-list/src/todolistediting.js

+ 5 - 0
packages/ckeditor5-list/src/todolistcheckcommand.js

@@ -12,6 +12,11 @@ import Command from '@ckeditor/ckeditor5-core/src/command';
 const attributeKey = 'todoListChecked';
 
 /**
+ * The to-do check command.
+ *
+ * The command is registered by the {@link module:list/todolistediting~TodoListEditing} as
+ * the `'todoListCheck'` editor command.
+ *
  * @extends module:core/command~Command
  */
 export default class TodoListCheckCommand extends Command {

+ 4 - 1
packages/ckeditor5-list/src/todolistediting.js

@@ -27,7 +27,10 @@ import {
  * The engine of the to-do list feature. It handles creating, editing and removing to-do lists and their items.
  *
  * It registers the entire functionality of the {@link module:list/listediting~ListEditing list editing plugin} and extends
- * it with the `'todoList'` command.
+ * it with the commands:
+ *
+ * - `'todoList'`,
+ * - `'todoListCheck'`.
  *
  * @extends module:core/plugin~Plugin
  */