Skip to content
This repository has been archived by the owner on Jun 26, 2020. It is now read-only.

Commit

Permalink
Avoid using the word Interface in interface names by simply stripping…
Browse files Browse the repository at this point in the history
… it.
  • Loading branch information
Reinmar committed Feb 8, 2018
1 parent 07925bb commit 7c0e6c9
Show file tree
Hide file tree
Showing 8 changed files with 16 additions and 16 deletions.
4 changes: 2 additions & 2 deletions src/button/buttoninterface.jsdoc → src/button/button.jsdoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@
*/

/**
* @module ui/button/buttoninterface
* @module ui/button/button
*/

/**
* The button interface. Implemented by, among others, {@link module:ui/button/buttonview~ButtonView},
* {@link module:ui/dropdown/button/splitbuttonview~SplitButtonView} and
* {@link module:ui/dropdown/button/dropdownbuttonview~DropdownButtonView}.
*
* @interface module:ui/button/buttoninterface~ButtonInterface
* @interface module:ui/button/button~Button
*/

/**
Expand Down
4 changes: 2 additions & 2 deletions src/button/buttonview.js
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ import '../../theme/components/button/button.css';
* document.body.append( view.element );
*
* @extends module:ui/view~View
* @implements module:ui/button/buttoninterface~ButtonInterface
* @implements module:ui/button/button~Button
*/
export default class ButtonView extends View {
/**
Expand All @@ -43,7 +43,7 @@ export default class ButtonView extends View {

const bind = this.bindTemplate;

// Implement ButtonInterface.
// Implement the Button interface.
this.set( 'icon' );
this.set( 'isEnabled', true );
this.set( 'isOn', false );
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@
*/

/**
* @module ui/dropdown/button/dropdownbuttoninterface
* @module ui/dropdown/button/dropdownbutton
*/

/**
* 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
*/

/**
Expand Down
4 changes: 2 additions & 2 deletions src/dropdown/button/dropdownbuttonview.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ import IconView from '../../icon/iconview';
*
* 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
*/
export default class DropdownButtonView extends ButtonView {
Expand All @@ -47,7 +47,7 @@ export default class DropdownButtonView extends ButtonView {
*/
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' );
}

Expand Down
4 changes: 2 additions & 2 deletions src/dropdown/button/splitbuttonview.js
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ import '../../../theme/components/dropdown/splitbutton.css';
*
* 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
*/
export default class SplitButtonView extends View {
Expand All @@ -46,7 +46,7 @@ export default class SplitButtonView extends View {

const bind = this.bindTemplate;

// Implement ButtonInterface.
// Implement the Button interface.
this.set( 'icon' );
this.set( 'isEnabled', true );
this.set( 'isOn', false );
Expand Down
2 changes: 1 addition & 1 deletion src/dropdown/dropdownview.js
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ export default class DropdownView extends View {
* Also see {@link #render}.
*
* @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
*/
constructor( locale, buttonView, panelView ) {
Expand Down
6 changes: 3 additions & 3 deletions src/dropdown/utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -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},
* 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.
*
* # Creating dropdowns
Expand All @@ -42,7 +42,7 @@ import '../../theme/components/dropdown/toolbardropdown.css';
* document.body.appendChild( dropdown.element );
*
* 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.
*
* const dropdown = createDropdown( model, SplitButtonView );
Expand Down Expand Up @@ -77,7 +77,7 @@ import '../../theme/components/dropdown/toolbardropdown.css';
*
* @param {module:utils/locale~Locale} locale The locale instance.
* @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.
*/
export function createDropdown( locale, ButtonClass = DropdownButtonView ) {
Expand Down
2 changes: 1 addition & 1 deletion tests/dropdown/button/splitbuttonview.js
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ describe( 'SplitButtonView', () => {
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', () => {
expect( view.actionView.type ).to.equal( 'button' );

Expand Down

0 comments on commit 7c0e6c9

Please sign in to comment.