8
0
Просмотр исходного кода

Docs: Table API docs improvements, part 5. [skip ci]

Anna Tomanek 6 лет назад
Родитель
Сommit
7f3f6d9362

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

@@ -13,7 +13,7 @@ import TablePropertyCommand from './tablepropertycommand';
  * The table alignment command.
  * The table alignment command.
  *
  *
  * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
  * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
- * `'tableAlignment'` editor command.
+ * the `'tableAlignment'` editor command.
  *
  *
  * To change the alignment of the selected table, execute the command:
  * To change the alignment of the selected table, execute the command:
  *
  *

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

@@ -13,7 +13,7 @@ import TablePropertyCommand from './tablepropertycommand';
  * The table background color command.
  * The table background color command.
  *
  *
  * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
  * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
- * `'tableBackgroundColor'` editor command.
+ * the `'tableBackgroundColor'` editor command.
  *
  *
  * To change the background color of the selected table, execute the command:
  * To change the background color of the selected table, execute the command:
  *
  *

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

@@ -14,7 +14,7 @@ import { getSingleValue } from '../../commands/utils';
  * The table border color command.
  * The table border color command.
  *
  *
  * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
  * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
- * `'tableBorderColor'` editor command.
+ * the `'tableBorderColor'` editor command.
  *
  *
  * To change the border color of the selected table, execute the command:
  * To change the border color of the selected table, execute the command:
  *
  *

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

@@ -14,7 +14,7 @@ import { getSingleValue } from '../../commands/utils';
  * The table style border command.
  * The table style border command.
  *
  *
  * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
  * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
- * `'tableBorderStyle'` editor command.
+ * the `'tableBorderStyle'` editor command.
  *
  *
  * To change the border style of the selected table, execute the command:
  * To change the border style of the selected table, execute the command:
  *
  *

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

@@ -14,7 +14,7 @@ import TablePropertyCommand from './tablepropertycommand';
  * The table width border command.
  * The table width border command.
  *
  *
  * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
  * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
- * `'tableBorderWidth'` editor command.
+ * the `'tableBorderWidth'` editor command.
  *
  *
  * To change the border width of the selected table, execute the command:
  * To change the border width of the selected table, execute the command:
  *
  *
@@ -28,7 +28,7 @@ import TablePropertyCommand from './tablepropertycommand';
  *			value: '5'
  *			value: '5'
  *		} );
  *		} );
  *
  *
- * Will set the `borderWidth` attribute to `'5px'` in the model.
+ * will set the `borderWidth` attribute to `'5px'` in the model.
  *
  *
  * @extends module:table/tableproperties/commands/tablepropertycommand
  * @extends module:table/tableproperties/commands/tablepropertycommand
  */
  */

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

@@ -14,9 +14,9 @@ import { addDefaultUnitToNumericValue } from '../../commands/utils';
  * The table height command.
  * The table height command.
  *
  *
  * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
  * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
- * `'tableHeight'` editor command.
+ * the `'tableHeight'` editor command.
  *
  *
- * To change height of the selected table, execute the command:
+ * To change the height of the selected table, execute the command:
  *
  *
  *		editor.execute( 'tableHeight', {
  *		editor.execute( 'tableHeight', {
  *			value: '500px'
  *			value: '500px'
@@ -28,7 +28,7 @@ import { addDefaultUnitToNumericValue } from '../../commands/utils';
  *			value: '50'
  *			value: '50'
  *		} );
  *		} );
  *
  *
- * Will set the `height` attribute to `'50px'` in the model.
+ * will set the `height` attribute to `'50px'` in the model.
  *
  *
  * @extends module:core/command~Command
  * @extends module:core/command~Command
  */
  */

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

@@ -14,7 +14,7 @@ import { findAncestor } from '../../commands/utils';
 /**
 /**
  * The table cell attribute command.
  * The table cell attribute command.
  *
  *
- * The command is a base command for other table property commands.
+ * This command is a base command for other table property commands.
  *
  *
  * @extends module:core/command~Command
  * @extends module:core/command~Command
  */
  */
@@ -52,7 +52,7 @@ export default class TablePropertyCommand extends Command {
 	 * @param {*} [options.value] If set, the command will set the attribute on the selected table.
 	 * @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.
 	 * 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,
 	 * @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.
+	 * for example, to allow a single undo step for multiple executions.
 	 */
 	 */
 	execute( options = {} ) {
 	execute( options = {} ) {
 		const model = this.editor.model;
 		const model = this.editor.model;
@@ -88,7 +88,7 @@ export default class TablePropertyCommand extends Command {
 	}
 	}
 
 
 	/**
 	/**
-	 * Returns the proper model value. Can be used to add a default unit to numeric values.
+	 * Returns the proper model value. It can be used to add a default unit to numeric values.
 	 *
 	 *
 	 * @private
 	 * @private
 	 * @param {*} value
 	 * @param {*} value

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

@@ -14,9 +14,9 @@ import TablePropertyCommand from './tablepropertycommand';
  * The table width command.
  * The table width command.
  *
  *
  * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
  * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
- * `'tableWidth'` editor command.
+ * the `'tableWidth'` editor command.
  *
  *
- * To change width of the selected table, execute the command:
+ * To change the width of the selected table, execute the command:
  *
  *
  *		editor.execute( 'tableWidth', {
  *		editor.execute( 'tableWidth', {
  *			value: '400px'
  *			value: '400px'
@@ -28,7 +28,7 @@ import TablePropertyCommand from './tablepropertycommand';
  *			value: '50'
  *			value: '50'
  *		} );
  *		} );
  *
  *
- * Will set the `width` attribute to `'50px'` in the model.
+ * will set the `width` attribute to `'50px'` in the model.
  *
  *
  * @extends module:table/tableproperties/commands/tablepropertycommand
  * @extends module:table/tableproperties/commands/tablepropertycommand
  */
  */