Skip to content

Commit d84998b

Browse files
devversionjelbourn
authored andcommitted
refactor: make mixin base classes docs private (#5301)
* The base classes that are used to apply mixins should not be show up in the generated docs
1 parent d0655ec commit d84998b

File tree

16 files changed

+17
-0
lines changed

16 files changed

+17
-0
lines changed

src/lib/button-toggle/button-toggle.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ import {CanDisable, mixinDisabled} from '../core/common-behaviors/disabled';
3333
export type ToggleType = 'checkbox' | 'radio';
3434

3535
// Boilerplate for applying mixins to MdButtonToggleGroup and MdButtonToggleGroupMultiple
36+
/** @docs-private */
3637
export class MdButtonToggleGroupBase {}
3738
export const _MdButtonToggleGroupMixinBase = mixinDisabled(MdButtonToggleGroupBase);
3839

src/lib/button/button.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,7 @@ export class MdMiniFab {
100100

101101

102102
// Boilerplate for applying mixins to MdButton.
103+
/** @docs-private */
103104
export class MdButtonBase {
104105
constructor(public _renderer: Renderer2, public _elementRef: ElementRef) {}
105106
}

src/lib/checkbox/checkbox.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ export class MdCheckboxChange {
6666
}
6767

6868
// Boilerplate for applying mixins to MdCheckbox.
69+
/** @docs-private */
6970
export class MdCheckboxBase {
7071
constructor(public _renderer: Renderer2, public _elementRef: ElementRef) {}
7172
}

src/lib/chips/chip.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ export interface MdChipEvent {
2626
}
2727

2828
// Boilerplate for applying mixins to MdChip.
29+
/** @docs-private */
2930
export class MdChipBase {
3031
constructor(public _renderer: Renderer2, public _elementRef: ElementRef) {}
3132
}

src/lib/core/option/optgroup.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import {Component, ViewEncapsulation, ContentChildren, QueryList, Input} from '@
1010
import {mixinDisabled, CanDisable} from '../common-behaviors/disabled';
1111

1212
// Boilerplate for applying mixins to MdOptgroup.
13+
/** @docs-private */
1314
export class MdOptgroupBase { }
1415
export const _MdOptgroupMixinBase = mixinDisabled(MdOptgroupBase);
1516

src/lib/core/selection/pseudo-checkbox/pseudo-checkbox.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ export type MdPseudoCheckboxState = 'unchecked' | 'checked' | 'indeterminate';
1919

2020

2121
// Boilerplate for applying mixins to MdChip.
22+
/** @docs-private */
2223
export class MdPseudoCheckboxBase {
2324
constructor(public _renderer: Renderer2, public _elementRef: ElementRef) {}
2425
}

src/lib/icon/icon.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ import {CanColor, mixinColor} from '../core/common-behaviors/color';
2323

2424

2525
// Boilerplate for applying mixins to MdIcon.
26+
/** @docs-private */
2627
export class MdIconBase {
2728
constructor(public _renderer: Renderer2, public _elementRef: ElementRef) {}
2829
}

src/lib/menu/menu-item.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import {Focusable} from '../core/a11y/focus-key-manager';
1111
import {CanDisable, mixinDisabled} from '../core/common-behaviors/disabled';
1212

1313
// Boilerplate for applying mixins to MdMenuItem.
14+
/** @docs-private */
1415
export class MdMenuItemBase {}
1516
export const _MdMenuItemMixinBase = mixinDisabled(MdMenuItemBase);
1617

src/lib/progress-spinner/progress-spinner.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ type EasingFn = (currentTime: number, startValue: number,
5757
export class MdProgressSpinnerCssMatStyler {}
5858

5959
// Boilerplate for applying mixins to MdProgressSpinner.
60+
/** @docs-private */
6061
export class MdProgressSpinnerBase {
6162
constructor(public _renderer: Renderer2, public _elementRef: ElementRef) {}
6263
}

src/lib/radio/radio.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ export class MdRadioChange {
6363

6464

6565
// Boilerplate for applying mixins to MdRadioGroup.
66+
/** @docs-private */
6667
export class MdRadioGroupBase { }
6768
export const _MdRadioGroupMixinBase = mixinDisabled(MdRadioGroupBase);
6869

@@ -296,6 +297,7 @@ export class MdRadioGroup extends _MdRadioGroupMixinBase
296297
}
297298

298299
// Boilerplate for applying mixins to MdRadioButton.
300+
/** @docs-private */
299301
export class MdRadioButtonBase {
300302
constructor(public _renderer: Renderer2, public _elementRef: ElementRef) {}
301303
}

src/lib/select/select.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,7 @@ export class MdSelectChange {
110110
}
111111

112112
// Boilerplate for applying mixins to MdSelect.
113+
/** @docs-private */
113114
export class MdSelectBase {
114115
constructor(public _renderer: Renderer2, public _elementRef: ElementRef) {}
115116
}

src/lib/slide-toggle/slide-toggle.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ let nextId = 0;
5454

5555

5656
// Boilerplate for applying mixins to MdSlideToggle.
57+
/** @docs-private */
5758
export class MdSlideToggleBase {
5859
constructor(public _renderer: Renderer2, public _elementRef: ElementRef) {}
5960
}

src/lib/slider/slider.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ export class MdSliderChange {
7171

7272

7373
// Boilerplate for applying mixins to MdSlider.
74+
/** @docs-private */
7475
export class MdSliderBase { }
7576
export const _MdSliderMixinBase = mixinDisabled(MdSliderBase);
7677

src/lib/tabs/tab-label-wrapper.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import {Directive, ElementRef} from '@angular/core';
1010
import {CanDisable, mixinDisabled} from '../core/common-behaviors/disabled';
1111

1212
// Boilerplate for applying mixins to MdTabLabelWrapper.
13+
/** @docs-private */
1314
export class MdTabLabelWrapperBase {}
1415
export const _MdTabLabelWrapperMixinBase = mixinDisabled(MdTabLabelWrapperBase);
1516

src/lib/tabs/tab.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ import {CanDisable, mixinDisabled} from '../core/common-behaviors/disabled';
1515
import {MdTabLabel} from './tab-label';
1616

1717
// Boilerplate for applying mixins to MdTab.
18+
/** @docs-private */
1819
export class MdTabBase {}
1920
export const _MdTabMixinBase = mixinDisabled(MdTabBase);
2021

src/lib/toolbar/toolbar.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ import {CanColor, mixinColor} from '../core/common-behaviors/color';
2424
export class MdToolbarRow {}
2525

2626
// Boilerplate for applying mixins to MdToolbar.
27+
/** @docs-private */
2728
export class MdToolbarBase {
2829
constructor(public _renderer: Renderer2, public _elementRef: ElementRef) {}
2930
}

0 commit comments

Comments
 (0)