8
0
Szymon Kupś 9 лет назад
Родитель
Сommit
69a3c2e9ab

+ 1 - 1
packages/ckeditor5-heading/src/headings.js

@@ -13,7 +13,7 @@ import ListDropdownView from '../ui/dropdown/list/listdropdownview.js';
 import Collection from '../utils/collection.js';
 
 /**
- * The headings feature. Handles switching between different block types.
+ * The headings feature. Introduces a "headings" drop-down and a command which allow switching paragraphs into headings.
  *
  * @memberOf headings
  * @extends ckeditor5.Feature

+ 5 - 1
packages/ckeditor5-heading/src/headingscommand.js

@@ -66,7 +66,11 @@ export default class HeadingsCommand extends Command {
 	}
 
 	/**
-	 * @inheritDoc
+	 * Executes the command if it is enabled.
+	 *
+	 * @param {String} [formatId] Identifier of the headings format that should be applied. It should be one of the
+	 * {@link headings.HeadingsFormat} provided to the command's constructor. If this parameter is not provided, value
+	 * from {@link headings.HeadingsCommand#defaultFormat defaultFormat} will be used.
 	 */
 	_doExecute( formatId = this.defaultFormat.id ) {
 		// TODO: What should happen if format is not found?

+ 1 - 2
packages/ckeditor5-heading/src/headingsengine.js

@@ -20,8 +20,7 @@ const formats = [
 
 /**
  * The headings feature. Handles switching between block formats - different headings and paragraph.
- * This class represents part of the feature that can be used without any UI - for example inside
- * Node.js environment.
+ * This class represents the engine part of the Headings feature.
  *
  * @memberOf headings
  * @extends ckeditor5.Feature