Преглед на файлове

Docs: Improved docs in various modules.

Aleksander Nowodzinski преди 5 години
родител
ревизия
556d50aa7d

+ 3 - 2
packages/ckeditor5-table/src/table.js

@@ -85,8 +85,9 @@ export default class Table extends Plugin {
  *			'#FF0000'
  *		]
  *
- * Usually used as a configuration, for instance in {@link module:table/table~TableConfig#tableProperties}
- * or {@link module:table/table~TableConfig#tableCellProperties}.
+ * Usually used as a configuration parameter, for instance in
+ * {@link module:table/table~TableConfig#tableProperties `config.table.tableProperties`}
+ * or {@link module:table/table~TableConfig#tableCellProperties `config.table.tableCellProperties`}.
  *
  * @typedef {Array.<String|Object>} module:table/table~TableColorConfig
  */

+ 3 - 3
packages/ckeditor5-table/src/tablecellproperties/ui/tablecellpropertiesview.js

@@ -75,7 +75,7 @@ export default class TableCellPropertiesView extends View {
 		super( locale );
 
 		/**
-		 * Options passed to the view.
+		 * Options passed to the view. See {@link #constructor} to learn more.
 		 *
 		 * @member {Object}
 		 */
@@ -212,7 +212,7 @@ export default class TableCellPropertiesView extends View {
 		 * An input that allows specifying the color of the table cell border.
 		 *
 		 * @readonly
-		 * @member {module:ui/inputtext/inputtextview~InputTextView}
+		 * @member {module:table/ui/colorinputview~ColorInputView}
 		 */
 		this.borderColorInput = borderColorInput;
 
@@ -220,7 +220,7 @@ export default class TableCellPropertiesView extends View {
 		 * An input that allows specifying the table cell background color.
 		 *
 		 * @readonly
-		 * @member {module:ui/inputtext/inputtextview~InputTextView}
+		 * @member {module:table/ui/colorinputview~ColorInputView}
 		 */
 		this.backgroundInput = this._createBackgroundField();
 

+ 3 - 3
packages/ckeditor5-table/src/tableproperties/ui/tablepropertiesview.js

@@ -67,7 +67,7 @@ export default class TablePropertiesView extends View {
 		super( locale );
 
 		/**
-		 * Options passed to the view.
+		 * Options passed to the view. See {@link #constructor} to learn more.
 		 *
 		 * @protected
 		 * @member {Object}
@@ -187,7 +187,7 @@ export default class TablePropertiesView extends View {
 		 * An input that allows specifying the color of the table border.
 		 *
 		 * @readonly
-		 * @member {module:ui/inputtext/inputtextview~InputTextView}
+		 * @member {module:table/ui/colorinputview~ColorInputView}
 		 */
 		this.borderColorInput = borderColorInput;
 
@@ -195,7 +195,7 @@ export default class TablePropertiesView extends View {
 		 * An input that allows specifying the table background color.
 		 *
 		 * @readonly
-		 * @member {module:ui/inputtext/inputtextview~InputTextView}
+		 * @member {module:table/ui/colorinputview~ColorInputView}
 		 */
 		this.backgroundInput = this._createBackgroundField();
 

+ 3 - 2
packages/ckeditor5-table/src/ui/utils.js

@@ -236,8 +236,9 @@ export function fillToolbar( { view, icons, toolbar, labels, propertyName } ) {
 }
 
 /**
- * A default color palette for table properties used in various user interfaces, for instance,
- * by {@link module:table/tablecellproperties~TableCellProperties} or {@link module:table/tableproperties~TableProperties}.
+ * A default color palette used by various user interfaces related to tables, for instance,
+ * by {@link module:table/tablecellproperties/tablecellpropertiesui~TableCellPropertiesUI} or
+ * {@link module:table/tableproperties/tablepropertiesui~TablePropertiesUI}.
  *
  * The color palette follows the {@link module:table/table~TableColorConfig table color configuration format}
  * and contains the following color definitions: