浏览代码

Docs: Minor fixes.

Aleksander Nowodzinski 6 年之前
父节点
当前提交
05eaafd715

+ 3 - 2
packages/ckeditor5-special-characters/src/specialcharactersui.js

@@ -17,6 +17,8 @@ import SpecialCharactersNavigationView from './ui/specialcharactersnavigationvie
 /**
  * The special characters UI plugin.
  *
+ * Introduces the `'specialCharacters'` dropdown.
+ *
  * @extends module:core/plugin~Plugin
  */
 export default class SpecialCharactersUI extends Plugin {
@@ -79,8 +81,7 @@ export default class SpecialCharactersUI extends Plugin {
 	 *
 	 * @private
 	 * @param {module:special-characters/specialcharacters~SpecialCharacters} specialCharsPlugin
-	 * @param {module:special-characters/ui/specialcharactersnavigationview~SpecialCharactersNavigationView#currentGroupName}
-	 * currentGroupName
+	 * @param {String} currentGroupName
 	 * @param {module:special-characters/ui/charactergridview~CharacterGridView} gridView
 	 */
 	_updateGrid( specialCharsPlugin, currentGroupName, gridView ) {

+ 3 - 3
packages/ckeditor5-special-characters/src/ui/charactergridview.js

@@ -24,7 +24,7 @@ export default class CharacterGridView extends View {
 	 *
 	 * @param {module:utils/locale~Locale} locale The localization services instance.
 	 * @param {Object} options Component configuration
-	 * @param {Number} options.columns A number of columns in the grid.
+	 * @param {Number} [options.columns] A number of columns in the grid.
 	 */
 	constructor( locale, options ) {
 		super( locale );
@@ -56,7 +56,7 @@ export default class CharacterGridView extends View {
 		} );
 
 		/**
-		 * Fired when any {@link #tiles grid tiles} is clicked.
+		 * Fired when any of {@link #tiles grid tiles} is clicked.
 		 *
 		 * @event execute
 		 * @param {Object} data Additional information about the event.
@@ -69,7 +69,7 @@ export default class CharacterGridView extends View {
 	 *
 	 * @param {String} character A human-readable character displayed as label (e.g. "ε").
 	 * @param {String} name A name of the character (e.g. "greek small letter epsilon").
-	 * @returns {module:ui/button/button~ButtonView}
+	 * @returns {module:ui/button/buttonview~ButtonView}
 	 */
 	createTile( character, name ) {
 		const tile = new ButtonView( this.locale );

+ 2 - 2
packages/ckeditor5-special-characters/src/ui/specialcharactersnavigationview.js

@@ -18,7 +18,7 @@ import {
 
 /**
  * A class representing the navigation part of the special characters UI. It is responsible
- * for describing the feature and selecting a particular character group by the user.
+ * for describing the feature and allowing the user to select a particular character group.
  *
  * @extends module:ui/view~View
  */
@@ -66,7 +66,7 @@ export default class SpecialCharactersNavigationView extends View {
 	}
 
 	/**
-	 * Returns a name of the character groups currently selected in the {@link #groupDropdownView}.
+	 * Returns a name of the character group currently selected in the {@link #groupDropdownView}.
 	 *
 	 * @returns {String}
 	 */