Sfoglia il codice sorgente

Improve documentation.

Maciej Gołaszewski 6 anni fa
parent
commit
77f0a42bf5

+ 2 - 2
packages/ckeditor5-indent/src/indent.js

@@ -19,8 +19,8 @@ import IndentUI from './indentui';
  *
  * The compatible features are:
  *
- * - the {@link module:list/list~List} or {@link module:list/listediting~ListEditing} feature for list indentation
- * * the {@link module:list/list~List} or {@link module:list/listediting~ListEditing} feature for list indentation
+ * * The {@link module:list/list~List} or {@link module:list/listediting~ListEditing} feature for list indentation.
+ * * The {@link module:indent/indentblock~IndentBlock} feature for block indentation.
  *
  * This is a "glue" plugin which loads the following plugins:
  *

+ 1 - 1
packages/ckeditor5-indent/src/indentblockcommand.js

@@ -105,7 +105,7 @@ export default class IndentBlockCommand extends Command {
  */
 
 /**
- * Returns new indent attribute value based on current indent.
+ * Returns new indent attribute value based on current indent. Method returns undefined when indentation should be removed.
  *
  * @method #getNextIndent
  * @param {String} indentAttributeValue Current indent attribute value.

+ 1 - 1
packages/ckeditor5-indent/src/indentcommandbehavior/indentusingclasses.js

@@ -14,7 +14,7 @@
  */
 export default class IndentUsingClasses {
 	/**
-	 * Creates an instance of the command.
+	 * Creates an instance of the behavior.
 	 *
 	 * @param {Object} config
 	 * @param {String} config.direction The direction of indentation.

+ 2 - 0
packages/ckeditor5-indent/src/indentcommandbehavior/indentusingoffset.js

@@ -8,6 +8,8 @@
  */
 
 /**
+ * The block indentation behavior that uses offsets to set indentation.
+ *
  * @implements module:indent/indentblockcommand~IndentBehavior
  */
 export default class IndentUsingOffset {

+ 1 - 1
packages/ckeditor5-indent/src/indentediting.js

@@ -16,7 +16,7 @@ import MultiCommand from '@ckeditor/ckeditor5-core/src/multicommand';
  * This plugin registers the `'indent'` and `'outdent'` commands.
  *
  * **Note**: In order the commands to work at least one of compatible features is required. Read more in
- * {@link module:indent/indent~Indent indent feature} api docs.
+ * {@link module:indent/indent~Indent indent feature} API docs.
  *
  * @extends module:core/plugin~Plugin
  */