Selaa lähdekoodia

Avoid using the word Interface in interface names by simply stripping it.

Piotrek Koszuliński 8 vuotta sitten
vanhempi
sitoutus
cb31ac1935

+ 2 - 2
packages/ckeditor5-ui/src/button/buttoninterface.jsdoc → packages/ckeditor5-ui/src/button/button.jsdoc

@@ -4,7 +4,7 @@
  */
  */
 
 
 /**
 /**
- * @module ui/button/buttoninterface
+ * @module ui/button/button
  */
  */
 
 
 /**
 /**
@@ -12,7 +12,7 @@
  * {@link module:ui/dropdown/button/splitbuttonview~SplitButtonView} and
  * {@link module:ui/dropdown/button/splitbuttonview~SplitButtonView} and
  * {@link module:ui/dropdown/button/dropdownbuttonview~DropdownButtonView}.
  * {@link module:ui/dropdown/button/dropdownbuttonview~DropdownButtonView}.
  *
  *
- * @interface module:ui/button/buttoninterface~ButtonInterface
+ * @interface module:ui/button/button~Button
  */
  */
 
 
 /**
 /**

+ 2 - 2
packages/ckeditor5-ui/src/button/buttonview.js

@@ -32,7 +32,7 @@ import '../../theme/components/button/button.css';
  *		document.body.append( view.element );
  *		document.body.append( view.element );
  *
  *
  * @extends module:ui/view~View
  * @extends module:ui/view~View
- * @implements module:ui/button/buttoninterface~ButtonInterface
+ * @implements module:ui/button/button~Button
  */
  */
 export default class ButtonView extends View {
 export default class ButtonView extends View {
 	/**
 	/**
@@ -43,7 +43,7 @@ export default class ButtonView extends View {
 
 
 		const bind = this.bindTemplate;
 		const bind = this.bindTemplate;
 
 
-		// Implement ButtonInterface.
+		// Implement the Button interface.
 		this.set( 'icon' );
 		this.set( 'icon' );
 		this.set( 'isEnabled', true );
 		this.set( 'isEnabled', true );
 		this.set( 'isOn', false );
 		this.set( 'isOn', false );

+ 3 - 3
packages/ckeditor5-ui/src/dropdown/button/dropdownbuttoninterface.jsdoc → packages/ckeditor5-ui/src/dropdown/button/dropdownbutton.jsdoc

@@ -4,14 +4,14 @@
  */
  */
 
 
 /**
 /**
- * @module ui/dropdown/button/dropdownbuttoninterface
+ * @module ui/dropdown/button/dropdownbutton
  */
  */
 
 
 /**
 /**
  * The dropdown button interface.
  * The dropdown button interface.
  *
  *
- * @interface module:ui/dropdown/button/dropdownbuttoninterface~DropdownButtonInterface
- * @extends module:ui/button/buttoninterface~ButtonInterface
+ * @interface module:ui/dropdown/button/dropdownbutton~DropdownButton
+ * @extends module:ui/button/button~Button
  */
  */
 
 
 /**
 /**

+ 2 - 2
packages/ckeditor5-ui/src/dropdown/button/dropdownbuttonview.js

@@ -29,7 +29,7 @@ import IconView from '../../icon/iconview';
  *
  *
  * Also see the {@link module:ui/dropdown/utils~createDropdown `createDropdown()` util}.
  * Also see the {@link module:ui/dropdown/utils~createDropdown `createDropdown()` util}.
  *
  *
- * @implements module:ui/dropdown/button/dropdownbuttoninterface~DropdownButtonInterface
+ * @implements module:ui/dropdown/button/dropdownbutton~DropdownButton
  * @extends module:ui/button/buttonview~ButtonView
  * @extends module:ui/button/buttonview~ButtonView
  */
  */
 export default class DropdownButtonView extends ButtonView {
 export default class DropdownButtonView extends ButtonView {
@@ -47,7 +47,7 @@ export default class DropdownButtonView extends ButtonView {
 		 */
 		 */
 		this.arrowView = this._createArrowView();
 		this.arrowView = this._createArrowView();
 
 
-		// DropdownButtonInterface expects the open event upon which the dropdown will open.
+		// The DropdownButton interface expects the open event upon which will open the dropdown.
 		this.delegate( 'execute' ).to( this, 'open' );
 		this.delegate( 'execute' ).to( this, 'open' );
 	}
 	}
 
 

+ 2 - 2
packages/ckeditor5-ui/src/dropdown/button/splitbuttonview.js

@@ -34,7 +34,7 @@ import '../../../theme/components/dropdown/splitbutton.css';
  *
  *
  * Also see the {@link module:ui/dropdown/utils~createDropdown `createDropdown()` util}.
  * Also see the {@link module:ui/dropdown/utils~createDropdown `createDropdown()` util}.
  *
  *
- * @implements module:ui/dropdown/button/dropdownbuttoninterface~DropdownButtonInterface
+ * @implements module:ui/dropdown/button/dropdownbutton~DropdownButton
  * @extends module:ui/view~View
  * @extends module:ui/view~View
  */
  */
 export default class SplitButtonView extends View {
 export default class SplitButtonView extends View {
@@ -46,7 +46,7 @@ export default class SplitButtonView extends View {
 
 
 		const bind = this.bindTemplate;
 		const bind = this.bindTemplate;
 
 
-		// Implement ButtonInterface.
+		// Implement the Button interface.
 		this.set( 'icon' );
 		this.set( 'icon' );
 		this.set( 'isEnabled', true );
 		this.set( 'isEnabled', true );
 		this.set( 'isOn', false );
 		this.set( 'isOn', false );

+ 1 - 1
packages/ckeditor5-ui/src/dropdown/dropdownview.js

@@ -70,7 +70,7 @@ export default class DropdownView extends View {
 	 * Also see {@link #render}.
 	 * Also see {@link #render}.
 	 *
 	 *
 	 * @param {module:utils/locale~Locale} [locale] The localization services instance.
 	 * @param {module:utils/locale~Locale} [locale] The localization services instance.
-	 * @param {module:ui/dropdown/button/dropdownbuttoninterface~DropdownButtonInterface} buttonView
+	 * @param {module:ui/dropdown/button/dropdownbutton~DropdownButton} buttonView
 	 * @param {module:ui/dropdown/dropdownpanelview~DropdownPanelView} panelView
 	 * @param {module:ui/dropdown/dropdownpanelview~DropdownPanelView} panelView
 	 */
 	 */
 	constructor( locale, buttonView, panelView ) {
 	constructor( locale, buttonView, panelView ) {

+ 3 - 3
packages/ckeditor5-ui/src/dropdown/utils.js

@@ -20,7 +20,7 @@ import '../../theme/components/dropdown/toolbardropdown.css';
 
 
 /**
 /**
  * A helper for creating dropdowns. It creates an instance of a {@link module:ui/dropdown/dropdownview~DropdownView dropdown},
  * A helper for creating dropdowns. It creates an instance of a {@link module:ui/dropdown/dropdownview~DropdownView dropdown},
- * with a {@link module:ui/dropdown/button/dropdownbuttoninterface~DropdownButtonInterface button},
+ * with a {@link module:ui/dropdown/button/dropdownbutton~DropdownButton button},
  * {@link module:ui/dropdown/dropdownpanelview~DropdownPanelView panel} and all standard dropdown's behaviors.
  * {@link module:ui/dropdown/dropdownpanelview~DropdownPanelView panel} and all standard dropdown's behaviors.
  *
  *
  * # Creating dropdowns
  * # Creating dropdowns
@@ -42,7 +42,7 @@ import '../../theme/components/dropdown/toolbardropdown.css';
  *		document.body.appendChild( dropdown.element );
  *		document.body.appendChild( dropdown.element );
  *
  *
  * You can also provide other button views (they need to implement the
  * You can also provide other button views (they need to implement the
- * {module:ui/dropdown/button/dropdownbuttoninterface~DropdownButtonInterface} interface). For instance, you can use
+ * {module:ui/dropdown/button/dropdownbutton~DropdownButton} interface). For instance, you can use
  * {@link module:ui/dropdown/button/splitbuttonview~SplitButtonView} to create a dropdown with a split button.
  * {@link module:ui/dropdown/button/splitbuttonview~SplitButtonView} to create a dropdown with a split button.
  *
  *
  *		const dropdown = createDropdown( model, SplitButtonView );
  *		const dropdown = createDropdown( model, SplitButtonView );
@@ -77,7 +77,7 @@ import '../../theme/components/dropdown/toolbardropdown.css';
  *
  *
  * @param {module:utils/locale~Locale} locale The locale instance.
  * @param {module:utils/locale~Locale} locale The locale instance.
  * @param {Function} ButtonClass The dropdown button view class. Needs to implement the
  * @param {Function} ButtonClass The dropdown button view class. Needs to implement the
- * {@link module:ui/dropdown/button/dropdownbuttoninterface~DropdownButtonInterface} interface.
+ * {@link module:ui/dropdown/button/dropdownbutton~DropdownButton} interface.
  * @returns {module:ui/dropdown/dropdownview~DropdownView} The dropdown view instance.
  * @returns {module:ui/dropdown/dropdownview~DropdownView} The dropdown view instance.
  */
  */
 export function createDropdown( locale, ButtonClass = DropdownButtonView ) {
 export function createDropdown( locale, ButtonClass = DropdownButtonView ) {

+ 1 - 1
packages/ckeditor5-ui/tests/dropdown/button/splitbuttonview.js

@@ -187,7 +187,7 @@ describe( 'SplitButtonView', () => {
 			expect( view.actionView.tabindex ).to.equal( 1 );
 			expect( view.actionView.tabindex ).to.equal( 1 );
 		} );
 		} );
 
 
-		// Makes little sense for split button but ButtonInterface specifies it, so let's support it.
+		// Makes little sense for split button but the Button interface specifies it, so let's support it.
 		it( 'binds actionView#type to view', () => {
 		it( 'binds actionView#type to view', () => {
 			expect( view.actionView.type ).to.equal( 'button' );
 			expect( view.actionView.type ).to.equal( 'button' );