瀏覽代碼

Docs: API docs corrections.

Marek Lewandowski 6 年之前
父節點
當前提交
0744a6b9f2

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

@@ -56,7 +56,7 @@ export default class SpecialCharacters extends Plugin {
 	 * Adds a collection of special characters to specified group. A title of a special character must be unique.
 	 *
 	 * @param {String} groupName
-	 * @param {Array.<~SpecialCharacterDefinition>} items
+	 * @param {Array.<module:special-characters/specialcharacters~SpecialCharacterDefinition>} items
 	 */
 	addItems( groupName, items ) {
 		const group = this._getGroup( groupName );
@@ -67,7 +67,8 @@ export default class SpecialCharacters extends Plugin {
 				 * The provided title for a special character is already. Titles for special characters must be unique.
 				 *
 				 * @error specialcharacters-duplicated-character-name
-				 * @param {~SpecialCharacterDefinition} item The invalid special character definition.
+				 * @param {module:special-characters/specialcharacters~SpecialCharacterDefinition} item The invalid
+				 * special character definition.
 				 */
 				throw new CKEditorError(
 					'specialcharacters-duplicated-character-name: Duplicated special character title.', null, { item }

+ 1 - 1
packages/ckeditor5-special-characters/src/ui/specialcharactersselectview.js

@@ -22,7 +22,7 @@ export default class SpecialCharactersSelectView extends View {
 	 * @param {module:utils/locale~Locale} [locale] The localization services instance.
 	 * @param {Object} options
 	 * @param {String} options.labelText A label for the select element.
-	 * @param {Array.<module:ui/select/selectview~SelectViewOption>} options.selectOptions Options to chose in the select view.
+	 * @param {Array.<module:ui/select/selectview~SelectViewItem>} options.selectOptions Options to chose in the select view.
 	 */
 	constructor( locale, options ) {
 		super( locale );

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

@@ -70,11 +70,11 @@ export default class SpecialCharactersTableView extends View {
 		this.symbolDefinitions = symbolDefinitions;
 
 		/**
-		 * Preserves the reference to {@link module:ui/symbolgrid/symbolgrid~SymbolGridView} used to create
+		 * Preserves the reference to {@link module:special-characters/ui/symbolgridview~SymbolGridView} used to create
 		 * the default (static) symbol set.
 		 *
 		 * @readonly
-		 * @member {module:ui/symbolgrid/symbolgrid~SymbolGridView}
+		 * @member {module:special-characters/ui/symbolgridview~SymbolGridView}
 		 */
 		this.symbolGridView = this._createSymbolGridView();
 
@@ -145,7 +145,7 @@ export default class SpecialCharactersTableView extends View {
 	 * Creates a static symbol table grid based on the editor configuration.
 	 *
 	 * @private
-	 * @returns {module:ui/symbolgrid/symbolgrid~SymbolGridView}
+	 * @returns {module:special-characters/ui/symbolgridview~SymbolGridView}
 	 */
 	_createSymbolGridView() {
 		const symbolGrid = new SymbolGridView( this.locale, {

+ 4 - 4
packages/ckeditor5-special-characters/src/ui/symbolgridview.js

@@ -15,18 +15,18 @@ import KeystrokeHandler from '@ckeditor/ckeditor5-utils/src/keystrokehandler';
 import '../../theme/components/symbolgrid/symbolgrid.css';
 
 /**
- * A grid of {@link module:special-characters/ui/symboltileview~symbolTileView symbol tiles}.
+ * A grid of {@link module:special-characters/ui/symboltileview~SymbolTileView symbol tiles}.
  *
  * @extends module:ui/view~View
  */
 export default class SymbolGridView extends View {
 	/**
-	 * Creates an instance of a symbol grid containing {@link module:special-characters/ui/symboltileview~symbolTileView tiles}.
+	 * Creates an instance of a symbol grid containing {@link module:special-characters/ui/symboltileview~SymbolTileView tiles}.
 	 *
 	 * @param {module:utils/locale~Locale} [locale] The localization services instance.
 	 * @param {Object} options Component configuration
-	 * @param {Array.<module:ui/symbolgrid/symbolgrid~symbolDefinition>} [options.symbolDefinitions] Array with definitions
-	 * required to create the {@link module:special-characters/ui/symboltileview~symbolTileView tiles}.
+	 * @param {Array.<module:special-characters/specialcharacters~SpecialCharacterDefinition>} [options.symbolDefinitions] Array with definitions
+	 * required to create the {@link module:special-characters/ui/symboltileview~SymbolTileView tiles}.
 	 * @param {Number} options.columns A number of columns to display the tiles.
 	 */
 	constructor( locale, options ) {