From d84998be3dcd4a2d8b11d6eb28549b7d5eb2d04d Mon Sep 17 00:00:00 2001 From: Paul Gschwendtner Date: Fri, 23 Jun 2017 17:58:14 +0200 Subject: [PATCH] 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 --- src/lib/button-toggle/button-toggle.ts | 1 + src/lib/button/button.ts | 1 + src/lib/checkbox/checkbox.ts | 1 + src/lib/chips/chip.ts | 1 + src/lib/core/option/optgroup.ts | 1 + src/lib/core/selection/pseudo-checkbox/pseudo-checkbox.ts | 1 + src/lib/icon/icon.ts | 1 + src/lib/menu/menu-item.ts | 1 + src/lib/progress-spinner/progress-spinner.ts | 1 + src/lib/radio/radio.ts | 2 ++ src/lib/select/select.ts | 1 + src/lib/slide-toggle/slide-toggle.ts | 1 + src/lib/slider/slider.ts | 1 + src/lib/tabs/tab-label-wrapper.ts | 1 + src/lib/tabs/tab.ts | 1 + src/lib/toolbar/toolbar.ts | 1 + 16 files changed, 17 insertions(+) diff --git a/src/lib/button-toggle/button-toggle.ts b/src/lib/button-toggle/button-toggle.ts index a473863983c..2183429bfdd 100644 --- a/src/lib/button-toggle/button-toggle.ts +++ b/src/lib/button-toggle/button-toggle.ts @@ -33,6 +33,7 @@ import {CanDisable, mixinDisabled} from '../core/common-behaviors/disabled'; export type ToggleType = 'checkbox' | 'radio'; // Boilerplate for applying mixins to MdButtonToggleGroup and MdButtonToggleGroupMultiple +/** @docs-private */ export class MdButtonToggleGroupBase {} export const _MdButtonToggleGroupMixinBase = mixinDisabled(MdButtonToggleGroupBase); diff --git a/src/lib/button/button.ts b/src/lib/button/button.ts index c29acbd8bea..e62a36ede75 100644 --- a/src/lib/button/button.ts +++ b/src/lib/button/button.ts @@ -100,6 +100,7 @@ export class MdMiniFab { // Boilerplate for applying mixins to MdButton. +/** @docs-private */ export class MdButtonBase { constructor(public _renderer: Renderer2, public _elementRef: ElementRef) {} } diff --git a/src/lib/checkbox/checkbox.ts b/src/lib/checkbox/checkbox.ts index 32552c15760..83d7df83cc2 100644 --- a/src/lib/checkbox/checkbox.ts +++ b/src/lib/checkbox/checkbox.ts @@ -66,6 +66,7 @@ export class MdCheckboxChange { } // Boilerplate for applying mixins to MdCheckbox. +/** @docs-private */ export class MdCheckboxBase { constructor(public _renderer: Renderer2, public _elementRef: ElementRef) {} } diff --git a/src/lib/chips/chip.ts b/src/lib/chips/chip.ts index fc9cf1818a7..d3c55538986 100644 --- a/src/lib/chips/chip.ts +++ b/src/lib/chips/chip.ts @@ -26,6 +26,7 @@ export interface MdChipEvent { } // Boilerplate for applying mixins to MdChip. +/** @docs-private */ export class MdChipBase { constructor(public _renderer: Renderer2, public _elementRef: ElementRef) {} } diff --git a/src/lib/core/option/optgroup.ts b/src/lib/core/option/optgroup.ts index 64baea2acda..fa063a4d91f 100644 --- a/src/lib/core/option/optgroup.ts +++ b/src/lib/core/option/optgroup.ts @@ -10,6 +10,7 @@ import {Component, ViewEncapsulation, ContentChildren, QueryList, Input} from '@ import {mixinDisabled, CanDisable} from '../common-behaviors/disabled'; // Boilerplate for applying mixins to MdOptgroup. +/** @docs-private */ export class MdOptgroupBase { } export const _MdOptgroupMixinBase = mixinDisabled(MdOptgroupBase); diff --git a/src/lib/core/selection/pseudo-checkbox/pseudo-checkbox.ts b/src/lib/core/selection/pseudo-checkbox/pseudo-checkbox.ts index f19baec5aea..ab026e2874a 100644 --- a/src/lib/core/selection/pseudo-checkbox/pseudo-checkbox.ts +++ b/src/lib/core/selection/pseudo-checkbox/pseudo-checkbox.ts @@ -19,6 +19,7 @@ export type MdPseudoCheckboxState = 'unchecked' | 'checked' | 'indeterminate'; // Boilerplate for applying mixins to MdChip. +/** @docs-private */ export class MdPseudoCheckboxBase { constructor(public _renderer: Renderer2, public _elementRef: ElementRef) {} } diff --git a/src/lib/icon/icon.ts b/src/lib/icon/icon.ts index 17e9c82621e..74da8e6554f 100644 --- a/src/lib/icon/icon.ts +++ b/src/lib/icon/icon.ts @@ -23,6 +23,7 @@ import {CanColor, mixinColor} from '../core/common-behaviors/color'; // Boilerplate for applying mixins to MdIcon. +/** @docs-private */ export class MdIconBase { constructor(public _renderer: Renderer2, public _elementRef: ElementRef) {} } diff --git a/src/lib/menu/menu-item.ts b/src/lib/menu/menu-item.ts index dbf0720c3e7..d471dd3d42a 100644 --- a/src/lib/menu/menu-item.ts +++ b/src/lib/menu/menu-item.ts @@ -11,6 +11,7 @@ import {Focusable} from '../core/a11y/focus-key-manager'; import {CanDisable, mixinDisabled} from '../core/common-behaviors/disabled'; // Boilerplate for applying mixins to MdMenuItem. +/** @docs-private */ export class MdMenuItemBase {} export const _MdMenuItemMixinBase = mixinDisabled(MdMenuItemBase); diff --git a/src/lib/progress-spinner/progress-spinner.ts b/src/lib/progress-spinner/progress-spinner.ts index 52eb0467ae4..aaa74d42e05 100644 --- a/src/lib/progress-spinner/progress-spinner.ts +++ b/src/lib/progress-spinner/progress-spinner.ts @@ -57,6 +57,7 @@ type EasingFn = (currentTime: number, startValue: number, export class MdProgressSpinnerCssMatStyler {} // Boilerplate for applying mixins to MdProgressSpinner. +/** @docs-private */ export class MdProgressSpinnerBase { constructor(public _renderer: Renderer2, public _elementRef: ElementRef) {} } diff --git a/src/lib/radio/radio.ts b/src/lib/radio/radio.ts index 08a38898a2b..febc665e636 100644 --- a/src/lib/radio/radio.ts +++ b/src/lib/radio/radio.ts @@ -63,6 +63,7 @@ export class MdRadioChange { // Boilerplate for applying mixins to MdRadioGroup. +/** @docs-private */ export class MdRadioGroupBase { } export const _MdRadioGroupMixinBase = mixinDisabled(MdRadioGroupBase); @@ -296,6 +297,7 @@ export class MdRadioGroup extends _MdRadioGroupMixinBase } // Boilerplate for applying mixins to MdRadioButton. +/** @docs-private */ export class MdRadioButtonBase { constructor(public _renderer: Renderer2, public _elementRef: ElementRef) {} } diff --git a/src/lib/select/select.ts b/src/lib/select/select.ts index 642fae370e3..d6e4ab223fe 100644 --- a/src/lib/select/select.ts +++ b/src/lib/select/select.ts @@ -110,6 +110,7 @@ export class MdSelectChange { } // Boilerplate for applying mixins to MdSelect. +/** @docs-private */ export class MdSelectBase { constructor(public _renderer: Renderer2, public _elementRef: ElementRef) {} } diff --git a/src/lib/slide-toggle/slide-toggle.ts b/src/lib/slide-toggle/slide-toggle.ts index 4047a2695b0..fb664608060 100644 --- a/src/lib/slide-toggle/slide-toggle.ts +++ b/src/lib/slide-toggle/slide-toggle.ts @@ -54,6 +54,7 @@ let nextId = 0; // Boilerplate for applying mixins to MdSlideToggle. +/** @docs-private */ export class MdSlideToggleBase { constructor(public _renderer: Renderer2, public _elementRef: ElementRef) {} } diff --git a/src/lib/slider/slider.ts b/src/lib/slider/slider.ts index f5936197f92..c34ef52c00e 100644 --- a/src/lib/slider/slider.ts +++ b/src/lib/slider/slider.ts @@ -71,6 +71,7 @@ export class MdSliderChange { // Boilerplate for applying mixins to MdSlider. +/** @docs-private */ export class MdSliderBase { } export const _MdSliderMixinBase = mixinDisabled(MdSliderBase); diff --git a/src/lib/tabs/tab-label-wrapper.ts b/src/lib/tabs/tab-label-wrapper.ts index bf3dafbc4c0..3fe5b1a657d 100644 --- a/src/lib/tabs/tab-label-wrapper.ts +++ b/src/lib/tabs/tab-label-wrapper.ts @@ -10,6 +10,7 @@ import {Directive, ElementRef} from '@angular/core'; import {CanDisable, mixinDisabled} from '../core/common-behaviors/disabled'; // Boilerplate for applying mixins to MdTabLabelWrapper. +/** @docs-private */ export class MdTabLabelWrapperBase {} export const _MdTabLabelWrapperMixinBase = mixinDisabled(MdTabLabelWrapperBase); diff --git a/src/lib/tabs/tab.ts b/src/lib/tabs/tab.ts index 1983aaad809..b0ef3b7c1cb 100644 --- a/src/lib/tabs/tab.ts +++ b/src/lib/tabs/tab.ts @@ -15,6 +15,7 @@ import {CanDisable, mixinDisabled} from '../core/common-behaviors/disabled'; import {MdTabLabel} from './tab-label'; // Boilerplate for applying mixins to MdTab. +/** @docs-private */ export class MdTabBase {} export const _MdTabMixinBase = mixinDisabled(MdTabBase); diff --git a/src/lib/toolbar/toolbar.ts b/src/lib/toolbar/toolbar.ts index 28df0fa5bef..772869c8fad 100644 --- a/src/lib/toolbar/toolbar.ts +++ b/src/lib/toolbar/toolbar.ts @@ -24,6 +24,7 @@ import {CanColor, mixinColor} from '../core/common-behaviors/color'; export class MdToolbarRow {} // Boilerplate for applying mixins to MdToolbar. +/** @docs-private */ export class MdToolbarBase { constructor(public _renderer: Renderer2, public _elementRef: ElementRef) {} }