소스 검색

Docs: Improved wording and fixed mistakes in various modules.

Aleksander Nowodzinski 6 년 전
부모
커밋
adb37d180f
21개의 변경된 파일77개의 추가작업 그리고 75개의 파일을 삭제
  1. 3 3
      packages/ckeditor5-table/src/tablecellproperties/commands/tablecellbackgroundcolorcommand.js
  2. 3 3
      packages/ckeditor5-table/src/tablecellproperties/commands/tablecellbordercolorcommand.js
  3. 3 3
      packages/ckeditor5-table/src/tablecellproperties/commands/tablecellborderstylecommand.js
  4. 3 3
      packages/ckeditor5-table/src/tablecellproperties/commands/tablecellborderwidthcommand.js
  5. 3 3
      packages/ckeditor5-table/src/tablecellproperties/commands/tablecellheightcommand.js
  6. 3 3
      packages/ckeditor5-table/src/tablecellproperties/commands/tablecellhorizontalalignmentcommand.js
  7. 3 3
      packages/ckeditor5-table/src/tablecellproperties/commands/tablecellpaddingcommand.js
  8. 7 6
      packages/ckeditor5-table/src/tablecellproperties/commands/tablecellpropertycommand.js
  9. 5 5
      packages/ckeditor5-table/src/tablecellproperties/commands/tablecellverticalalignmentcommand.js
  10. 3 3
      packages/ckeditor5-table/src/tablecellproperties/commands/tablecellwidthcommand.js
  11. 1 1
      packages/ckeditor5-table/src/tablecellproperties/tablecellpropertiesediting.js
  12. 3 3
      packages/ckeditor5-table/src/tableproperties/commands/tablealignmentcommand.js
  13. 3 3
      packages/ckeditor5-table/src/tableproperties/commands/tablebackgroundcolorcommand.js
  14. 3 3
      packages/ckeditor5-table/src/tableproperties/commands/tablebordercolorcommand.js
  15. 3 3
      packages/ckeditor5-table/src/tableproperties/commands/tableborderstylecommand.js
  16. 3 3
      packages/ckeditor5-table/src/tableproperties/commands/tableborderwidthcommand.js
  17. 2 2
      packages/ckeditor5-table/src/tableproperties/commands/tableheightcommand.js
  18. 7 6
      packages/ckeditor5-table/src/tableproperties/commands/tablepropertycommand.js
  19. 2 2
      packages/ckeditor5-table/src/tableproperties/commands/tablewidthcommand.js
  20. 1 1
      packages/ckeditor5-table/src/tableproperties/tablepropertiesediting.js
  21. 13 13
      packages/ckeditor5-table/tests/_utils/utils.js

+ 3 - 3
packages/ckeditor5-table/src/tablecellproperties/commands/tablecellbackgroundcolorcommand.js

@@ -12,10 +12,10 @@ import TableCellPropertyCommand from './tablecellpropertycommand';
 /**
  * The table cell background color command.
  *
- * The command is registered by {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing} as
+ * The command is registered by the {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing} as
  * `'tableCellBackgroundColor'` editor command.
  *
- * To change cell `backgroundColor` attribute of the selected cells, execute the command:
+ * To change the background color of selected cells, execute the command:
  *
  *		editor.execute( 'tableCellBackgroundColor', {
  *			value: '#f00'
@@ -27,7 +27,7 @@ export default class TableCellBackgroundColorCommand extends TableCellPropertyCo
 	/**
 	 * Creates a new `TableCellBackgroundColorCommand` instance.
 	 *
-	 * @param {module:core/editor/editor~Editor} editor Editor on which this command will be used.
+	 * @param {module:core/editor/editor~Editor} editor An editor in which this command will be used.
 	 */
 	constructor( editor ) {
 		super( editor, 'backgroundColor' );

+ 3 - 3
packages/ckeditor5-table/src/tablecellproperties/commands/tablecellbordercolorcommand.js

@@ -13,10 +13,10 @@ import { getSingleValue } from '../../commands/utils';
 /**
  * The table cell border color command.
  *
- * The command is registered by {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing} as
+ * The command is registered by the {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing} as
  * `'tableCellBorderColor'` editor command.
  *
- * To change cell border color of the selected cell, execute the command:
+ * To change the border color of selected cells, execute the command:
  *
  *		editor.execute( 'tableCellBorderColor', {
  *			value: '#f00'
@@ -28,7 +28,7 @@ export default class TableCellBorderColorCommand extends TableCellPropertyComman
 	/**
 	 * Creates a new `TableCellBorderWidthCommand` instance.
 	 *
-	 * @param {module:core/editor/editor~Editor} editor Editor on which this command will be used.
+	 * @param {module:core/editor/editor~Editor} editor An editor in which this command will be used.
 	 */
 	constructor( editor ) {
 		super( editor, 'borderColor' );

+ 3 - 3
packages/ckeditor5-table/src/tablecellproperties/commands/tablecellborderstylecommand.js

@@ -13,10 +13,10 @@ import { getSingleValue } from '../../commands/utils';
 /**
  * The table cell border style command.
  *
- * The command is registered by {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing} as
+ * The command is registered by the {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing} as
  * `'tableCellBorderStyle'` editor command.
  *
- * To change cell border style of the selected cell, execute the command:
+ * To change the border style of selected cells, execute the command:
  *
  *		editor.execute( 'tableCellBorderStyle', {
  *			value: 'dashed'
@@ -28,7 +28,7 @@ export default class TableCellBorderStyleCommand extends TableCellPropertyComman
 	/**
 	 * Creates a new `TableCellBorderWidthCommand` instance.
 	 *
-	 * @param {module:core/editor/editor~Editor} editor Editor on which this command will be used.
+	 * @param {module:core/editor/editor~Editor} editor An editor in which this command will be used.
 	 */
 	constructor( editor ) {
 		super( editor, 'borderStyle' );

+ 3 - 3
packages/ckeditor5-table/src/tablecellproperties/commands/tablecellborderwidthcommand.js

@@ -13,10 +13,10 @@ import { getSingleValue } from '../../commands/utils';
 /**
  * The table cell border width command.
  *
- * The command is registered by {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing} as
+ * The command is registered by the {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing} as
  * `'tableCellBorderWidth'` editor command.
  *
- * To change cell border width of the selected cell, execute the command:
+ * To change the border width of selected cells, execute the command:
  *
  *		editor.execute( 'tableCellBorderWidth', {
  *			value: '5px'
@@ -28,7 +28,7 @@ export default class TableCellBorderWidthCommand extends TableCellPropertyComman
 	/**
 	 * Creates a new `TableCellBorderWidthCommand` instance.
 	 *
-	 * @param {module:core/editor/editor~Editor} editor Editor on which this command will be used.
+	 * @param {module:core/editor/editor~Editor} editor An editor in which this command will be used.
 	 */
 	constructor( editor ) {
 		super( editor, 'borderWidth' );

+ 3 - 3
packages/ckeditor5-table/src/tablecellproperties/commands/tablecellheightcommand.js

@@ -12,10 +12,10 @@ import TableCellPropertyCommand from './tablecellpropertycommand';
 /**
  * The table cell height command.
  *
- * The command is registered by {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing} as
+ * The command is registered by the {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing} as
  * `'tableCellHeight'` editor command.
  *
- * To change cell height of the selected cell, execute the command:
+ * To change the height of selected cells, execute the command:
  *
  *		editor.execute( 'tableCellHeight', {
  *			value: '50px'
@@ -27,7 +27,7 @@ export default class TableCellHeightCommand extends TableCellPropertyCommand {
 	/**
 	 * Creates a new `TableCellHeightCommand` instance.
 	 *
-	 * @param {module:core/editor/editor~Editor} editor Editor on which this command will be used.
+	 * @param {module:core/editor/editor~Editor} editor An editor in which this command will be used.
 	 */
 	constructor( editor ) {
 		super( editor, 'height' );

+ 3 - 3
packages/ckeditor5-table/src/tablecellproperties/commands/tablecellhorizontalalignmentcommand.js

@@ -12,10 +12,10 @@ import TableCellPropertyCommand from './tablecellpropertycommand';
 /**
  * The table cell horizontal alignment command.
  *
- * The command is registered by {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing} as
+ * The command is registered by the {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing} as
  * `'tableCellHorizontalAlignment'` editor command.
  *
- * To change cell horizontal alignment of the selected cell, execute the command:
+ * To change the horizontal text alignment of selected cells, execute the command:
  *
  *		editor.execute( 'tableCellHorizontalAlignment', {
  *			value: 'right'
@@ -27,7 +27,7 @@ export default class TableCellHorizontalAlignmentCommand extends TableCellProper
 	/**
 	 * Creates a new `TableCellHorizontalAlignmentCommand` instance.
 	 *
-	 * @param {module:core/editor/editor~Editor} editor Editor on which this command will be used.
+	 * @param {module:core/editor/editor~Editor} editor An editor in which this command will be used.
 	 */
 	constructor( editor ) {
 		super( editor, 'horizontalAlignment' );

+ 3 - 3
packages/ckeditor5-table/src/tablecellproperties/commands/tablecellpaddingcommand.js

@@ -13,10 +13,10 @@ import { getSingleValue } from '../../commands/utils';
 /**
  * The table cell padding command.
  *
- * The command is registered by {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing} as
+ * The command is registered by the {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing} as
  * `'tableCellPadding'` editor command.
  *
- * To change cell padding of the selected cell, execute the command:
+ * To change the padding of selected cells, execute the command:
  *
  *		editor.execute( 'tableCellPadding', {
  *			value: '5px'
@@ -28,7 +28,7 @@ export default class TableCellPaddingCommand extends TableCellPropertyCommand {
 	/**
 	 * Creates a new `TableCellPaddingCommand` instance.
 	 *
-	 * @param {module:core/editor/editor~Editor} editor Editor on which this command will be used.
+	 * @param {module:core/editor/editor~Editor} editor An editor in which this command will be used.
 	 */
 	constructor( editor ) {
 		super( editor, 'padding' );

+ 7 - 6
packages/ckeditor5-table/src/tablecellproperties/commands/tablecellpropertycommand.js

@@ -14,7 +14,7 @@ import { findAncestor } from '../../commands/utils';
 /**
  * The table cell attribute command.
  *
- * The command is a base command for other table cell attributes commands.
+ * The command is a base command for other table cell property commands.
  *
  * @extends module:core/command~Command
  */
@@ -22,7 +22,7 @@ export default class TableCellPropertyCommand extends Command {
 	/**
 	 * Creates a new `TableCellPropertyCommand` instance.
 	 *
-	 * @param {module:core/editor/editor~Editor} editor Editor on which this command will be used.
+	 * @param {module:core/editor/editor~Editor} editor An editor in which this command will be used.
 	 * @param {String} attributeName Table cell attribute name.
 	 */
 	constructor( editor, attributeName ) {
@@ -49,9 +49,10 @@ export default class TableCellPropertyCommand extends Command {
 	 *
 	 * @fires execute
 	 * @param {Object} [options]
-	 * @param {*} [options.value] If set the command will set the attribute on selected table cells.
-	 * If it is not set the command will remove the attribute from selected table cells.
-	 * @param {module:engine/model/batch~Batch} [options.batch] Pass batch instance to the command for creating single undo step.
+	 * @param {*} [options.value] If set, the command will set the attribute on selected table cells.
+	 * If it is not set, the command will remove the attribute from selected table cells.
+	 * @param {module:engine/model/batch~Batch} [options.batch] Pass the model batch instance to the command to aggregate changes,
+	 * e.g. allow a single undo step for multiple executions.
 	 */
 	execute( options = {} ) {
 		const model = this.editor.model;
@@ -72,7 +73,7 @@ export default class TableCellPropertyCommand extends Command {
 	}
 
 	/**
-	 * Returns attribute value for a table cell.
+	 * Returns the attribute value for a table cell.
 	 *
 	 * @param {module:engine/model/element~Element} tableCell
 	 * @returns {String|undefined}

+ 5 - 5
packages/ckeditor5-table/src/tablecellproperties/commands/tablecellverticalalignmentcommand.js

@@ -12,17 +12,17 @@ import TableCellPropertyCommand from './tablecellpropertycommand';
 /**
  * The table cell vertical alignment command.
  *
- * The command is registered by {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing} as
+ * The command is registered by the {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing} as
  * `'tableCellVerticalAlignment'` editor command.
  *
- * To change cell vertical alignment of the selected cell, execute the command:
+ * To change the vertical text alignment of selected cells, execute the command:
  *
  *		editor.execute( 'tableCellVerticalAlignment', {
  *			value: 'top'
  *		} );
  *
- * The editor UI allows to set those attributes from
- * [a `vertical-align` CSS attribute](https://developer.mozilla.org/en-US/docs/Web/CSS/vertical-align):
+ * The following values are allowed corresponding to
+ * [the `vertical-align` CSS attribute](https://developer.mozilla.org/en-US/docs/Web/CSS/vertical-align):
  *
  * * `'top'`
  * * `'bottom'`
@@ -34,7 +34,7 @@ export default class TableCellVerticalAlignmentCommand extends TableCellProperty
 	/**
 	 * Creates a new `TableCellVerticalAlignmentCommand` instance.
 	 *
-	 * @param {module:core/editor/editor~Editor} editor Editor on which this command will be used.
+	 * @param {module:core/editor/editor~Editor} editor An editor in which this command will be used.
 	 */
 	constructor( editor ) {
 		super( editor, 'verticalAlignment' );

+ 3 - 3
packages/ckeditor5-table/src/tablecellproperties/commands/tablecellwidthcommand.js

@@ -12,10 +12,10 @@ import TableCellPropertyCommand from './tablecellpropertycommand';
 /**
  * The table cell width command.
  *
- * The command is registered by {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing} as
+ * The command is registered by the {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing} as
  * `'tableCellWidth'` editor command.
  *
- * To change cell width of the selected cell, execute the command:
+ * To change the width of selected cells, execute the command:
  *
  *		editor.execute( 'tableCellWidth', {
  *			value: '50px'
@@ -27,7 +27,7 @@ export default class TableCellWidthCommand extends TableCellPropertyCommand {
 	/**
 	 * Creates a new `TableCellWidthCommand` instance.
 	 *
-	 * @param {module:core/editor/editor~Editor} editor Editor on which this command will be used.
+	 * @param {module:core/editor/editor~Editor} editor An editor in which this command will be used.
 	 */
 	constructor( editor ) {
 		super( editor, 'width' );

+ 1 - 1
packages/ckeditor5-table/src/tablecellproperties/tablecellpropertiesediting.js

@@ -104,7 +104,7 @@ function enableBorderProperties( schema, conversion ) {
 	downcastAttributeToStyle( conversion, 'tableCell', 'borderWidth', 'border-width' );
 }
 
-// Enables `'horizontalAlignment'` attribute for table cells.
+// Enables the `'horizontalAlignment'` attribute for table cells.
 //
 // @param {module:engine/model/schema~Schema} schema
 // @param {module:engine/conversion/conversion~Conversion} conversion

+ 3 - 3
packages/ckeditor5-table/src/tableproperties/commands/tablealignmentcommand.js

@@ -12,10 +12,10 @@ import TablePropertyCommand from './tablepropertycommand';
 /**
  * The table alignment command.
  *
- * The command is registered by {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
+ * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
  * `'tableAlignment'` editor command.
  *
- * To change alignment of the selected table, execute the command:
+ * To change the alignment of the selected table, execute the command:
  *
  *		editor.execute( 'tableAlignment', {
  *			value: 'right'
@@ -27,7 +27,7 @@ export default class TableAlignmentCommand extends TablePropertyCommand {
 	/**
 	 * Creates a new `TableAlignmentCommand` instance.
 	 *
-	 * @param {module:core/editor/editor~Editor} editor Editor on which this command will be used.
+	 * @param {module:core/editor/editor~Editor} editor An editor in which this command will be used.
 	 */
 	constructor( editor ) {
 		super( editor, 'alignment' );

+ 3 - 3
packages/ckeditor5-table/src/tableproperties/commands/tablebackgroundcolorcommand.js

@@ -12,10 +12,10 @@ import TablePropertyCommand from './tablepropertycommand';
 /**
  * The table background color command.
  *
- * The command is registered by {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
+ * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
  * `'tableBackgroundColor'` editor command.
  *
- * To change backgroundColor of the selected, execute the command:
+ * To change the background color of the selected table, execute the command:
  *
  *		editor.execute( 'tableBackgroundColor', {
  *			value: '#f00'
@@ -27,7 +27,7 @@ export default class TableBackgroundColorCommand extends TablePropertyCommand {
 	/**
 	 * Creates a new `TableBackgroundColorCommand` instance.
 	 *
-	 * @param {module:core/editor/editor~Editor} editor Editor on which this command will be used.
+	 * @param {module:core/editor/editor~Editor} editor An editor in which this command will be used.
 	 */
 	constructor( editor ) {
 		super( editor, 'backgroundColor' );

+ 3 - 3
packages/ckeditor5-table/src/tableproperties/commands/tablebordercolorcommand.js

@@ -13,10 +13,10 @@ import { getSingleValue } from '../../commands/utils';
 /**
  * The table border color command.
  *
- * The command is registered by {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
+ * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
  * `'tableBorderColor'` editor command.
  *
- * To change border color of the selected , execute the command:
+ * To change the border color of the selected table, execute the command:
  *
  *		editor.execute( 'tableBorderColor', {
  *			value: '#f00'
@@ -28,7 +28,7 @@ export default class TableBorderColorCommand extends TablePropertyCommand {
 	/**
 	 * Creates a new `TableBorderColorCommand` instance.
 	 *
-	 * @param {module:core/editor/editor~Editor} editor Editor on which this command will be used.
+	 * @param {module:core/editor/editor~Editor} editor An editor in which this command will be used.
 	 */
 	constructor( editor ) {
 		super( editor, 'borderColor' );

+ 3 - 3
packages/ckeditor5-table/src/tableproperties/commands/tableborderstylecommand.js

@@ -13,10 +13,10 @@ import { getSingleValue } from '../../commands/utils';
 /**
  * The table style border command.
  *
- * The command is registered by {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
+ * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
  * `'tableBorderStyle'` editor command.
  *
- * To change border of the selected , execute the command:
+ * To change the border style of the selected table, execute the command:
  *
  *		editor.execute( 'tableBorderStyle', {
  *			value: 'dashed'
@@ -28,7 +28,7 @@ export default class TableBorderStyleCommand extends TablePropertyCommand {
 	/**
 	 * Creates a new `TableBorderStyleCommand` instance.
 	 *
-	 * @param {module:core/editor/editor~Editor} editor Editor on which this command will be used.
+	 * @param {module:core/editor/editor~Editor} editor An editor in which this command will be used.
 	 */
 	constructor( editor ) {
 		super( editor, 'borderStyle' );

+ 3 - 3
packages/ckeditor5-table/src/tableproperties/commands/tableborderwidthcommand.js

@@ -13,10 +13,10 @@ import { getSingleValue } from '../../commands/utils';
 /**
  * The table width border command.
  *
- * The command is registered by {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
+ * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
  * `'tableBorderWidth'` editor command.
  *
- * To change border of the selected , execute the command:
+ * To change the border width of the selected table, execute the command:
  *
  *		editor.execute( 'tableBorderWidth', {
  *			value: '5px'
@@ -28,7 +28,7 @@ export default class TableBorderWidthCommand extends TablePropertyCommand {
 	/**
 	 * Creates a new `TableBorderWidthCommand` instance.
 	 *
-	 * @param {module:core/editor/editor~Editor} editor Editor on which this command will be used.
+	 * @param {module:core/editor/editor~Editor} editor An editor in which this command will be used.
 	 */
 	constructor( editor ) {
 		super( editor, 'borderWidth' );

+ 2 - 2
packages/ckeditor5-table/src/tableproperties/commands/tableheightcommand.js

@@ -12,7 +12,7 @@ import TablePropertyCommand from './tablepropertycommand';
 /**
  * The table height command.
  *
- * The command is registered by {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
+ * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
  * `'tableHeight'` editor command.
  *
  * To change height of the selected table, execute the command:
@@ -27,7 +27,7 @@ export default class TableHeightCommand extends TablePropertyCommand {
 	/**
 	 * Creates a new `TableHeightCommand` instance.
 	 *
-	 * @param {module:core/editor/editor~Editor} editor Editor on which this command will be used.
+	 * @param {module:core/editor/editor~Editor} editor An editor in which this command will be used.
 	 */
 	constructor( editor ) {
 		super( editor, 'height' );

+ 7 - 6
packages/ckeditor5-table/src/tableproperties/commands/tablepropertycommand.js

@@ -14,7 +14,7 @@ import { findAncestor } from '../../commands/utils';
 /**
  * The table cell attribute command.
  *
- * The command is a base command for other table cell attributes commands.
+ * The command is a base command for other table property commands.
  *
  * @extends module:core/command~Command
  */
@@ -22,7 +22,7 @@ export default class TablePropertyCommand extends Command {
 	/**
 	 * Creates a new `TablePropertyCommand` instance.
 	 *
-	 * @param {module:core/editor/editor~Editor} editor Editor on which this command will be used.
+	 * @param {module:core/editor/editor~Editor} editor An editor in which this command will be used.
 	 * @param {String} attributeName Table cell attribute name.
 	 */
 	constructor( editor, attributeName ) {
@@ -49,9 +49,10 @@ export default class TablePropertyCommand extends Command {
 	 *
 	 * @fires execute
 	 * @param {Object} [options]
-	 * @param {*} [options.value] If set the command will set the attribute on selected table.
-	 * If it is not set the command will remove the attribute from selected table.
-	 * @param {module:engine/model/batch~Batch} [options.batch] Pass batch instance to the command for creating single undo step.
+	 * @param {*} [options.value] If set, the command will set the attribute on the selected table.
+	 * If not set, the command will remove the attribute from the selected table.
+	 * @param {module:engine/model/batch~Batch} [options.batch] Pass the model batch instance to the command to aggregate changes,
+	 * e.g. allow a single undo step for multiple executions.
 	 */
 	execute( options = {} ) {
 		const model = this.editor.model;
@@ -71,7 +72,7 @@ export default class TablePropertyCommand extends Command {
 	}
 
 	/**
-	 * Returns attribute value for a table cell.
+	 * Returns the attribute value for a table.
 	 *
 	 * @param {module:engine/model/element~Element} table
 	 * @returns {String|undefined}

+ 2 - 2
packages/ckeditor5-table/src/tableproperties/commands/tablewidthcommand.js

@@ -12,7 +12,7 @@ import TablePropertyCommand from './tablepropertycommand';
 /**
  * The table width command.
  *
- * The command is registered by {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
+ * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
  * `'tableWidth'` editor command.
  *
  * To change width of the selected table, execute the command:
@@ -27,7 +27,7 @@ export default class TableWidthCommand extends TablePropertyCommand {
 	/**
 	 * Creates a new `TableWidthCommand` instance.
 	 *
-	 * @param {module:core/editor/editor~Editor} editor Editor on which this command will be used.
+	 * @param {module:core/editor/editor~Editor} editor An editor in which this command will be used.
 	 */
 	constructor( editor ) {
 		super( editor, 'width' );

+ 1 - 1
packages/ckeditor5-table/src/tableproperties/tablepropertiesediting.js

@@ -85,7 +85,7 @@ function enableBorderProperties( schema, conversion ) {
 	downcastTableAttribute( conversion, 'borderWidth', 'border-width' );
 }
 
-// Enables `'alignment'` attribute for table.
+// Enables the `'alignment'` attribute for table.
 //
 // @param {module:engine/model/schema~Schema} schema
 // @param {module:engine/conversion/conversion~Conversion} conversion

+ 13 - 13
packages/ckeditor5-table/tests/_utils/utils.js

@@ -57,7 +57,7 @@ export function modelTable( tableData, attributes ) {
 }
 
 /**
- * Helper method for creating a test table with a single table cell which attributes might be objects.
+ * A helper method for creating a test table with a single table cell of which attributes are defined as objects.
  *
  *		setTableCellWithObjectAttributes(
  *			model,
@@ -69,8 +69,8 @@ export function modelTable( tableData, attributes ) {
  *			'fo[o]'
  *		);
  *
- * This will create a model table with one table cell with a "foo" text. Selection will be set on last "o" and a table cell will have three
- * attributes.
+ * This will create a model table with one table cell with a "foo" text.
+ * The selection will be set on the last "o" and a table cell will have three attributes.
  *
  * @param {module:engine/model/model~Model} model
  * @param {Object} attributes
@@ -89,7 +89,7 @@ export function setTableCellWithObjectAttributes( model, attributes, cellContent
 }
 
 /**
- * Helper method for creating a test table, with a single table cell, which attributes might be objects.
+ * A helper method for creating a test table, with a single table cell. Table attributes are defined as objects.
  *
  *		setTableWithObjectAttributes(
  *			model,
@@ -100,8 +100,8 @@ export function setTableCellWithObjectAttributes( model, attributes, cellContent
  *			'fo[o]'
  *		);
  *
- * This will create a model table with one table cell with a "foo" text. Selection will be set on last "o" and a table will have three
- * attributes.
+ * This will create a model table with one table cell with a "foo" text.
+ * The selection will be set on last "o" and a table will have three attributes.
  *
  * @param {module:engine/model/model~Model} model
  * @param {Object} attributes
@@ -258,17 +258,17 @@ export function defaultConversion( conversion, asWidget = false ) {
 }
 
 /**
- * Assertion helper for top-right-bottom-left attribute object.
+ * An assertion helper for top-right-bottom-left attribute object.
  *
  * @param {module:engine/model/node~Node} element
  * @param {String} key Attribute key
- * @param {String} top Top value. Pass null to omit value in attributes object.
+ * @param {String} top Top value. Pass `null` to omit the value in the attributes object.
  * @param {String} [right=top] Right value - defaults to top if not provided.
- * Pass null to omit value in attributes object.
+ * Pass `null` to omit the value in the attributes object.
  * @param {String} [bottom=top] Bottom value - defaults to top (right value must be defined).
- * Pass null to omit value in attributes object.
+ * Pass `null` to omit the value in the attributes object.
  * @param {String} [left=right] Left value - defaults to right (bottom and right values must be defined).
- * Pass null to omit value in attributes object.
+ * Pass `null` to omit the value in the attributes object.
  */
 export function assertTRBLAttribute( element, key, top, right = top, bottom = top, left = right ) {
 	const styleObject = {};
@@ -293,7 +293,7 @@ export function assertTRBLAttribute( element, key, top, right = top, bottom = to
 }
 
 /**
- * Assertion helper for testing <table> style attribute.
+ * An assertion helper for testing the `<table>` style attribute.
  *
  * @param {module:core/editor/editor~Editor} editor
  * @param {String} tableStyle A style to assert on table.
@@ -307,7 +307,7 @@ export function assertTableStyle( editor, tableStyle ) {
 }
 
 /**
- * Assertion helper for testing <td> style attribute.
+ * An assertion helper for testing the `<td>` style attribute.
  *
  * @param {module:core/editor/editor~Editor} editor
  * @param {String} tableCellStyle A style to assert on td.