Przeglądaj źródła

Docs: Table feature API docs corrected, part 1. [skip ci]

Anna Tomanek 7 lat temu
rodzic
commit
017462cb78

+ 1 - 1
packages/ckeditor5-table/LICENSE.md

@@ -1,7 +1,7 @@
 Software License Agreement
 ==========================
 
-**Table feature for CKEditor 5** – https://github.com/ckeditor/ckeditor5-table <br>
+**CKEditor 5 Table Feature**  – https://github.com/ckeditor/ckeditor5-table <br>
 Copyright (c) 2003-2018, [CKSource](http://cksource.com) Frederico Knabben. All rights reserved.
 
 Licensed under the terms of [GNU General Public License Version 2 or later](http://www.gnu.org/licenses/gpl.html).

+ 1 - 1
packages/ckeditor5-table/README.md

@@ -10,7 +10,7 @@ CKEditor 5 table feature
 [![Dependency Status](https://david-dm.org/ckeditor/ckeditor5-table/status.svg)](https://david-dm.org/ckeditor/ckeditor5-table)
 [![devDependency Status](https://david-dm.org/ckeditor/ckeditor5-table/dev-status.svg)](https://david-dm.org/ckeditor/ckeditor5-table?type=dev)
 
-This package implements text table support for CKEditor 5.
+This package implements table support for CKEditor 5.
 
 ## Documentation
 

+ 4 - 3
packages/ckeditor5-table/src/tableediting.js

@@ -132,8 +132,8 @@ export default class TableEditing extends Plugin {
 	}
 
 	/**
-	 * Handles {@link module:engine/view/document~Document#event:keydown keydown} events for 'Tab' key executed
-	 * when table widget is selected.
+	 * Handles {@link module:engine/view/document~Document#event:keydown keydown} events for the <kbd>Tab</kbd> key executed
+	 * when the table widget is selected.
 	 *
 	 * @private
 	 * @param {module:utils/eventinfo~EventInfo} eventInfo
@@ -168,7 +168,8 @@ export default class TableEditing extends Plugin {
 	}
 
 	/**
-	 * Handles {@link module:engine/view/document~Document#event:keydown keydown} events for 'Tab' key executed inside table cell.
+	 * Handles {@link module:engine/view/document~Document#event:keydown keydown} events for the <kbd>Tab</kbd> key executed inside table
+	 * cell.
 	 *
 	 * @private
 	 * @param {module:utils/eventinfo~EventInfo} eventInfo

+ 4 - 4
packages/ckeditor5-table/src/tabletoolbar.js

@@ -16,7 +16,7 @@ import { repositionContextualBalloon, getBalloonPositionData } from './ui/utils'
 const balloonClassName = 'ck-toolbar-container';
 
 /**
- * The table toolbar class. Creates a table toolbar that shows up when the table widget is selected.
+ * The table toolbar class. It creates a table toolbar that shows up when the table widget is selected.
  *
  * Toolbar components are created using the editor {@link module:ui/componentfactory~ComponentFactory ComponentFactory}
  * based on the {@link module:core/editor/editor~Editor#config configuration} stored under `table.toolbar`.
@@ -80,7 +80,7 @@ export default class TableToolbar extends Plugin {
 		this._balloon = this.editor.plugins.get( 'ContextualBalloon' );
 
 		/**
-		 * A `ToolbarView` instance used to display the buttons specific for table editing.
+		 * A toolbar view instance used to display the buttons specific for table editing.
 		 *
 		 * @protected
 		 * @type {module:ui/toolbar/toolbarview~ToolbarView}
@@ -171,7 +171,7 @@ export default class TableToolbar extends Plugin {
  * Items to be placed in the table toolbar.
  * This option is used by the {@link module:table/tabletoolbar~TableToolbar} feature.
  *
- * Assuming that you use the {@link module:table/tableui~TableUI} feature the following toolbar items will be available
+ * Assuming that you use the {@link module:table/tableui~TableUI} feature, the following toolbar items will be available
  * in {@link module:ui/componentfactory~ComponentFactory}:
  *
  * * `'tableRow'`,
@@ -179,7 +179,7 @@ export default class TableToolbar extends Plugin {
  * * `'mergeCell'`,
  * * `'splitCell'`,
  *
- * so you can configure the toolbar like this:
+ * You can thus configure the toolbar like this:
  *
  *		const tableConfig = {
  *			toolbar: [ 'tableRow', 'tableColumn', 'mergeCell', 'splitCell' ]

+ 7 - 7
packages/ckeditor5-table/src/tableui.js

@@ -27,7 +27,7 @@ import tableMergeCellIcon from './../theme/icons/table-merge-cell.svg';
  * * The `'tableRow'` dropdown,
  * * The `'mergeCell'` dropdown.
  *
- * The `'tableColumn'`, `'tableRow'`, `'mergeCell'` work best with {@link module:table/tabletoolbar~TableToolbar}.
+ * The `'tableColumn'`, `'tableRow'`, `'mergeCell'` dropdowns work best with {@link module:table/tabletoolbar~TableToolbar}.
  *
  * @extends module:core/plugin~Plugin
  */
@@ -112,12 +112,12 @@ export default class TableUI extends Plugin {
 	}
 
 	/**
-	 * Creates dropdown view from set of options.
+	 * Creates a dropdown view from the set of options.
 	 *
 	 * @private
-	 * @param {String} buttonName Dropdown button name.
-	 * @param {String} icon Icon for dropdown button.
-	 * @param {Array.<module:table/tableui~DropdownOption>} options List of options for dropdown.
+	 * @param {String} buttonName The dropdown button name.
+	 * @param {String} icon An icon for the dropdown button.
+	 * @param {Array.<module:table/tableui~DropdownOption>} options The list of options for the dropdown.
 	 * @param {module:utils/locale~Locale} locale
 	 * @returns {module:ui/dropdown/dropdownview~DropdownView}
 	 */
@@ -192,11 +192,11 @@ function addListOption( option, editor, commands, dropdownItems ) {
 }
 
 /**
- * Object describing table dropdowns' items.
+ * An object describing the table dropdown items.
  *
  * @typedef {Object} module:table/tableui~DropdownOption
  * @private
  * @property {String} commandName A command name to execute for that option.
  * @property {String} label A dropdown item label.
- * @property {Boolean} bindIsActive If `true` will bind command's value to `isActive` dropdown item property.
+ * @property {Boolean} bindIsActive If `true`, it will bind the command's value to the `isActive` dropdown item property.
  */

+ 35 - 34
packages/ckeditor5-table/src/tableutils.js

@@ -14,7 +14,7 @@ import TableWalker from './tablewalker';
 import { getParentTable, updateNumericAttribute } from './commands/utils';
 
 /**
- * The table utils plugin.
+ * The table utilities plugin.
  *
  * @extends module:core/plugin~Plugin
  */
@@ -27,9 +27,9 @@ export default class TableUtils extends Plugin {
 	}
 
 	/**
-	 * Returns table cell location as an object with table row and table column indexes.
+	 * Returns the table cell location as an object with table row and table column indexes.
 	 *
-	 * For instance in a table below:
+	 * For instance in the table below:
 	 *
 	 *		    0   1   2   3
 	 *		  +---+---+---+---+
@@ -69,11 +69,11 @@ export default class TableUtils extends Plugin {
 	}
 
 	/**
-	 * Creates an empty table at given position.
+	 * Creates an empty table at a given position.
 	 *
-	 * @param {module:engine/model/position~Position} position Position at which insert a table.
-	 * @param {Number} rows Number of rows to create.
-	 * @param {Number} columns Number of columns to create.
+	 * @param {module:engine/model/position~Position} position The position where the table will be inserted.
+	 * @param {Number} rows The number of rows to create.
+	 * @param {Number} columns The number of columns to create.
 	 */
 	createTable( position, rows, columns ) {
 		const model = this.editor.model;
@@ -88,7 +88,7 @@ export default class TableUtils extends Plugin {
 	}
 
 	/**
-	 * Insert rows into a table.
+	 * Inserts rows into a table.
 	 *
 	 *		editor.plugins.get( 'TableUtils' ).insertRows( table, { at: 1, rows: 2 } );
 	 *
@@ -107,10 +107,10 @@ export default class TableUtils extends Plugin {
 	 *		                                       +   + f | g |
 	 *		                                       +---+---+---+ 5
 	 *
-	 * @param {module:engine/model/element~Element} table Table model element to which insert rows.
+	 * @param {module:engine/model/element~Element} table The table model element where the rows will be inserted.
 	 * @param {Object} options
-	 * @param {Number} [options.at=0] Row index at which insert rows.
-	 * @param {Number} [options.rows=1] Number of rows to insert.
+	 * @param {Number} [options.at=0] Row index at which the rows will be inserted.
+	 * @param {Number} [options.rows=1] The number of rows to insert.
 	 */
 	insertRows( table, options = {} ) {
 		const model = this.editor.model;
@@ -182,10 +182,10 @@ export default class TableUtils extends Plugin {
 	 *		+---+---+---+                   +---+---+---+---+---+
 	 *		    ^---- insert here, `at` = 1, `columns` = 2
 	 *
-	 * @param {module:engine/model/element~Element} table Table model element to which insert columns.
+	 * @param {module:engine/model/element~Element} table The table model element where the columns will be inserted.
 	 * @param {Object} options
-	 * @param {Number} [options.at=0] Column index at which insert columns.
-	 * @param {Number} [options.columns=1] Number of columns to insert.
+	 * @param {Number} [options.at=0] Column index at which the columns will be inserted.
+	 * @param {Number} [options.columns=1] The number of columns to insert.
 	 */
 	insertColumns( table, options = {} ) {
 		const model = this.editor.model;
@@ -246,9 +246,9 @@ export default class TableUtils extends Plugin {
 	}
 
 	/**
-	 * Divides table cell vertically into several ones.
+	 * Divides a table cell vertically into several ones.
 	 *
-	 * The cell will visually split to more cells by updating colspans of other cells in a column
+	 * The cell will be visually split into more cells by updating colspans of other cells in a column
 	 * and inserting cells (columns) after that cell.
 	 *
 	 * In the table below, if cell "a" is split to 3 cells:
@@ -267,10 +267,10 @@ export default class TableUtils extends Plugin {
 	 *		| d         | e | f |
 	 *		+---+---+---+---+---+
 	 *
-	 * So cell d will get updated `colspan` to 3 and 2 cells will be added (2 columns created).
+	 * So cell "d" will get its `colspan` updated to `3` and 2 cells will be added (2 columns will be created).
 	 *
-	 * Splitting cell that already has a colspan attribute set will distribute cell's colspan evenly and a reminder
-	 * will be left to original cell:
+	 * Splitting a cell that already has a `colspan` attribute set will distribute the cell `colspan` evenly and the remainder
+	 * will be left to the original cell:
 	 *
 	 *		+---+---+---+
 	 *		| a         |
@@ -278,7 +278,7 @@ export default class TableUtils extends Plugin {
 	 *		| b | c | d |
 	 *		+---+---+---+
 	 *
-	 * Splitting cell a with colspan=3 to a 2 cells will create 1 cell with colspan=2 and cell a will have colspan=1:
+	 * Splitting cell "a" with `colspan=3` to 2 cells will create 1 cell with a `colspan=a` and cell "a" that will have `colspan=2`:
 	 *
 	 *		+---+---+---+
 	 *		| a     |   |
@@ -369,11 +369,12 @@ export default class TableUtils extends Plugin {
 	}
 
 	/**
-	 * Divides table cell horizontally into several ones.
+	 * Divides a table cell horizontally into several ones.
 	 *
-	 * The cell will visually split to more cells by updating rowspans of other cells in a row and inserting rows with single cell below.
+	 * The cell will be visually split into more cells by updating rowspans of other cells in the row and inserting rows with a single cell
+	 * below.
 	 *
-	 * If in a table below cell b will be split to a 3 cells:
+	 * If in the table below cell "b" is split to 3 cells:
 	 *
 	 *		+---+---+---+
 	 *		| a | b | c |
@@ -381,7 +382,7 @@ export default class TableUtils extends Plugin {
 	 *		| d | e | f |
 	 *		+---+---+---+
 	 *
-	 * will result in a table below:
+	 * It will result in the table below:
 	 *
 	 *		+---+---+---+
 	 *		| a | b | c |
@@ -393,10 +394,10 @@ export default class TableUtils extends Plugin {
 	 *		| d | e | f |
 	 *		+---+---+---+
 	 *
-	 * So cells a & b will get updated `rowspan` to 3 and 2 rows with single cell will be added.
+	 * So cells "a" and "b" will get their `rowspan` updated to `3` and 2 rows with a single cell will be added.
 	 *
-	 * Splitting cell that has already a rowspan attribute set will distribute cell's rowspan evenly and a reminder
-	 * will be left to original cell:
+	 * Splitting a cell that already has a `rowspan` attribute set will distribute the cell `rowspan` evenly and the remainder
+	 * will be left to the original cell:
 	 *
 	 *		+---+---+---+
 	 *		| a | b | c |
@@ -408,7 +409,7 @@ export default class TableUtils extends Plugin {
 	 *		|   | h | i |
 	 *		+---+---+---+
 	 *
-	 * Splitting cell a with rowspan=4 to a 3 cells will create 2 cells with rowspan=1 and cell a will have rowspan=2:
+	 * Splitting cell "a" with `rowspan=4` to 3 cells will create 2 cells with a `rowspan=1` and cell "a" will have `rowspan=2`:
 	 *
 	 *		+---+---+---+
 	 *		| a | b | c |
@@ -522,11 +523,11 @@ export default class TableUtils extends Plugin {
 	}
 
 	/**
-	 * Returns number of columns for given table.
+	 * Returns the number of columns for a given table.
 	 *
 	 *		editor.plugins.get( 'TableUtils' ).getColumns( table );
 	 *
-	 * @param {module:engine/model/element~Element} table Table to analyze.
+	 * @param {module:engine/model/element~Element} table The table to analyze.
 	 * @returns {Number}
 	 */
 	getColumns( table ) {
@@ -541,7 +542,7 @@ export default class TableUtils extends Plugin {
 	}
 }
 
-// Creates empty rows at given index in an existing table.
+// Creates empty rows at the given index in an existing table.
 //
 // @param {module:engine/model/writer~Writer} writer
 // @param {module:engine/model/element~Element} table
@@ -558,7 +559,7 @@ function createEmptyRows( writer, table, insertAt, rows, tableCellToInsert, attr
 	}
 }
 
-// Creates cells at given position.
+// Creates cells at a given position.
 //
 // @param {Number} columns Number of columns to create
 // @param {module:engine/model/writer~Writer} writer
@@ -569,14 +570,14 @@ function createCells( cells, writer, insertPosition, attributes = {} ) {
 	}
 }
 
-// Evenly distributes span of a cell to a number of provided cells.
+// Evenly distributes the span of a cell to a number of provided cells.
 // The resulting spans will always be integer values.
 //
 // For instance breaking a span of 7 into 3 cells will return:
 //
 //		{ newCellsSpan: 2, updatedSpan: 3 }
 //
-// as two cells will have span of 2 and the reminder will go the first cell so it's span will change to 3.
+// as two cells will have a span of 2 and the remainder will go the first cell so its span will change to 3.
 //
 // @param {Number} span Span value do break.
 // @param {Number} numberOfCells Number of resulting spans.

+ 49 - 47
packages/ckeditor5-table/src/tablewalker.js

@@ -8,22 +8,22 @@
  */
 
 /**
- * Table iterator class. It allows to iterate over a table cells. For each cell the iterator yields
+ * Table iterator class. It allows to iterate over table cells. For each cell the iterator yields
  * {@link module:table/tablewalker~TableWalkerValue} with proper table cell attributes.
  */
 export default class TableWalker {
 	/**
-	 * Creates an instance of table walker.
+	 * Creates an instance of the table walker.
 	 *
 	 *
-	 * The TableWalker iterates internally by traversing table from row index = 0 and column index = 0.
-	 * It walks row by row and column by column in order to output values defined in constructor.
-	 * By default it will output only those locations that are occupied by a cell to include also a spanned rows & columns
-	 * pass `includeSpanned` option to a constructor.
+	 * The table walker iterates internally by traversing the table from row index = 0 and column index = 0.
+	 * It walks row by row and column by column in order to output values defined in the constructor.
+	 * By default it will output only those locations that are occupied by a cell. To include also spanned rows and columns,
+	 * pass the `includeSpanned` option to the constructor.
 	 *
-	 * The most important values of iterator values are column & row indexes of a cell.
+	 * The most important values of the iterator are column and row indexes of a cell.
 	 *
-	 * To iterate over given row:
+	 * To iterate over a given row:
 	 *
 	 *		const tableWalker = new TableWalker( table, { startRow: 1, endRow: 2 } );
 	 *
@@ -31,7 +31,7 @@ export default class TableWalker {
 	 *			console.log( 'A cell at row ' + cellInfo.row + ' and column ' + cellInfo.column );
 	 *		}
 	 *
-	 * For instance the above code for a table:
+	 * For instance the code above for the following table:
 	 *
 	 *		+----+----+----+----+----+----+
 	 *		| 00      | 02 | 03      | 05 |
@@ -50,7 +50,7 @@ export default class TableWalker {
 	 *		'A cell at row 1 and column 5'
 	 *		'A cell at row 2 and column 2'
 	 *
-	 * To iterate over spanned cells also:
+	 * To also iterate over spanned cells:
 	 *
 	 *		const tableWalker = new TableWalker( table, { startRow: 1, endRow: 1, includeSpanned: true } );
 	 *
@@ -68,8 +68,8 @@ export default class TableWalker {
 	 *		'Cell at 1 x 5 : has data'
 	 *
 	 * @constructor
-	 * @param {module:engine/model/element~Element} table A table over which iterate.
-	 * @param {Object} [options={}] Object with configuration.
+	 * @param {module:engine/model/element~Element} table A table over which the walker iterates.
+	 * @param {Object} [options={}] An object with configuration.
 	 * @param {Number} [options.column] A column index for which this iterator will output cells.
 	 * @param {Number} [options.startRow=0] A row index for which this iterator should start.
 	 * @param {Number} [options.endRow] A row index for which this iterator should end.
@@ -109,7 +109,7 @@ export default class TableWalker {
 		this.includeSpanned = !!options.includeSpanned;
 
 		/**
-		 * If set table walker will only output cells of given column or cells that overlaps it.
+		 * If set, the table walker will only output cells of a given column or cells that overlap it.
 		 *
 		 * @readonly
 		 * @member {Number}
@@ -117,7 +117,7 @@ export default class TableWalker {
 		this.column = typeof options.column == 'number' ? options.column : undefined;
 
 		/**
-		 * Row indexes to skip from iteration.
+		 * Row indexes to skip from the iteration.
 		 *
 		 * @readonly
 		 * @member {Set<Number>}
@@ -126,7 +126,7 @@ export default class TableWalker {
 		this._skipRows = new Set();
 
 		/**
-		 * A current row index.
+		 * The current row index.
 		 *
 		 * @readonly
 		 * @member {Number}
@@ -135,7 +135,7 @@ export default class TableWalker {
 		this._row = 0;
 
 		/**
-		 * A current column index.
+		 * The current column index.
 		 *
 		 * @readonly
 		 * @member {Number}
@@ -144,8 +144,8 @@ export default class TableWalker {
 		this._column = 0;
 
 		/**
-		 * A cell index in a parent row. For spanned cells when {@link #includeSpanned} is set to true
-		 * this represents the index of next table cell.
+		 * The cell index in a parent row. For spanned cells when {@link #includeSpanned} is set to `true`,
+		 * this represents the index of the next table cell.
 		 *
 		 * @readonly
 		 * @member {Number}
@@ -154,7 +154,7 @@ export default class TableWalker {
 		this._cell = 0;
 
 		/**
-		 * Holds map of spanned cells in a table.
+		 * Holds a map of spanned cells in a table.
 		 *
 		 * @readonly
 		 * @member {Map<Number, Map.<Number, Number>>}
@@ -175,7 +175,7 @@ export default class TableWalker {
 	/**
 	 * Gets the next table walker's value.
 	 *
-	 * @returns {module:table/tablewalker~TableWalkerValue} Next table walker's value.
+	 * @returns {module:table/tablewalker~TableWalkerValue} The next table walker's value.
 	 */
 	next() {
 		const row = this.table.getChild( this._row );
@@ -240,7 +240,8 @@ export default class TableWalker {
 	}
 
 	/**
-	 * Mark a row to skip on next iteration - will skip also cells from current row if any.
+	 * Marks a row to skip in the next iteration. It will also skip cells from the current row if there are any cells from the current row
+	 * to output.
 	 *
 	 * @param {Number} row Row index to skip.
 	 */
@@ -249,23 +250,24 @@ export default class TableWalker {
 	}
 
 	/**
-	 * Check if current row is over {@link #endRow}.
+	 * Checks if the current row is over {@link #endRow}.
 	 *
 	 * @returns {Boolean}
 	 * @private
 	 */
 	_isOverEndRow() {
-		// If {@link #endRow) is defined skipp all rows above it.
+		// If {@link #endRow) is defined skip all rows above it.
 		return this.endRow !== undefined && this._row > this.endRow;
 	}
 
 	/**
-	 * Common method for formatting iterator's out value.
+	 * A common method for formatting the iterator's output value.
 	 *
-	 * @param {module:engine/model/element~Element|undefined} cell Table cell to output. Might be undefined for spanned cell locations.
-	 * @param {Number} column Column index (use cached value)
-	 * @param {Number} rowspan Rowspan of current cell.
-	 * @param {Number} colspan Colspan of current cell.
+	 * @param {module:engine/model/element~Element|undefined} cell The table cell to output. It might be undefined for spanned cell
+	 * locations.
+	 * @param {Number} column Column index (use the cached value)
+	 * @param {Number} rowspan Rowspan of the current cell.
+	 * @param {Number} colspan Colspan of the current cell.
 	 * @returns {{done: boolean, value: {cell: *, row: Number, column: *, rowspan: *, colspan: *, cellIndex: Number}}}
 	 * @private
 	 */
@@ -284,7 +286,7 @@ export default class TableWalker {
 	}
 
 	/**
-	 * Checks if current row should be skipped.
+	 * Checks if the current row should be skipped.
 	 *
 	 * @returns {Boolean}
 	 * @private
@@ -297,7 +299,7 @@ export default class TableWalker {
 	}
 
 	/**
-	 * Checks if current column should be skipped.
+	 * Checks if the current column should be skipped.
 	 *
 	 * @param {Number} column
 	 * @param {Number} colspan
@@ -320,7 +322,7 @@ export default class TableWalker {
 	}
 
 	/**
-	 * Checks if current cell location - row x column - is spanned by other cell.
+	 * Checks if the current cell location (row x column) is spanned by another cell.
 	 *
 	 * @param {Number} row Row index of a cell location to check.
 	 * @param {Number} column Column index of a cell location to check.
@@ -340,12 +342,12 @@ export default class TableWalker {
 	}
 
 	/**
-	 * Updates spanned cells map relative to current cell location and it's span dimensions.
+	 * Updates spanned cells map relative to the current cell location and its span dimensions.
 	 *
 	 * @param {Number} row Row index of a cell.
 	 * @param {Number} column Column index of a cell.
-	 * @param {Number} rowspan Cell's height.
-	 * @param {Number} colspan Cell's width.
+	 * @param {Number} rowspan Cell height.
+	 * @param {Number} colspan Cell width.
 	 * @private
 	 */
 	_recordSpans( row, column, rowspan, colspan ) {
@@ -363,10 +365,10 @@ export default class TableWalker {
 	}
 
 	/**
-	 * Marks cell location as spanned by other cell.
+	 * Marks the cell location as spanned by another cell.
 	 *
-	 * @param {Number} row Row index of cell location.
-	 * @param {Number} column Column index of cell location.
+	 * @param {Number} row Row index of the cell location.
+	 * @param {Number} column Column index of the cell location.
 	 * @private
 	 */
 	_markSpannedCell( row, column ) {
@@ -381,17 +383,17 @@ export default class TableWalker {
 }
 
 /**
- * Object returned by {@link module:table/tablewalker~TableWalker} when traversing table cells.
+ * An object returned by {@link module:table/tablewalker~TableWalker} when traversing table cells.
  *
  * @typedef {Object} module:table/tablewalker~TableWalkerValue
- * @property {module:engine/model/element~Element} [cell] Current table cell. Might be empty if
- * {@link module:table/tablewalker~TableWalker#includeSpanned} is set to true.
+ * @property {module:engine/model/element~Element} [cell] The current table cell. Might be empty if
+ * {@link module:table/tablewalker~TableWalker#includeSpanned} is set to `true`.
  * @property {Number} row The row index of a cell.
- * @property {Number} column The column index of a cell. Column index is adjusted to widths & heights of previous cells.
- * @property {Number} [colspan] The colspan attribute of a cell - always defined even if model attribute is not present. Not set if
- * {@link module:table/tablewalker~TableWalker#includeSpanned} is set to true.
- * @property {Number} [rowspan] The rowspan attribute of a cell - always defined even if model attribute is not present. Not set if
- * {@link module:table/tablewalker~TableWalker#includeSpanned} is set to true.
- * @property {Number} cellIndex The index of a current cell in a parent row. When using `includeSpanned` option it will indicate next child
- * index if #cell is empty (which indicates that cell is spanned by other cell).
+ * @property {Number} column The column index of a cell. Column index is adjusted to widths and heights of previous cells.
+ * @property {Number} [colspan] The `colspan` attribute of a cell. It is always defined even if the model attribute is not present. Not
+ * set if {@link module:table/tablewalker~TableWalker#includeSpanned} is set to `true`.
+ * @property {Number} [rowspan] The `rowspan` attribute of a cell. It is always defined even if the model attribute is not present. Not
+ * set if {@link module:table/tablewalker~TableWalker#includeSpanned} is set to `true`.
+ * @property {Number} cellIndex The index of the current cell in a parent row. When using the `includeSpanned` option it will indicate the
+ * next child index if #cell is empty (which indicates that the cell is spanned by another cell).
  */