From 6d0ce9c2406559577e63acb87c25769045a74a05 Mon Sep 17 00:00:00 2001 From: Andrew Seguin Date: Wed, 8 Mar 2017 13:46:40 -0800 Subject: [PATCH] docs(tabs): make non-exported comps as docs private --- src/lib/tabs/index.ts | 23 ++++++++++++++++++++--- src/lib/tabs/ink-bar.ts | 5 ++++- src/lib/tabs/tab-body.ts | 1 + src/lib/tabs/tab-header.ts | 1 + src/lib/tabs/tab-label-wrapper.ts | 5 ++++- 5 files changed, 30 insertions(+), 5 deletions(-) diff --git a/src/lib/tabs/index.ts b/src/lib/tabs/index.ts index 51dcf3760728..eff6d6da7d84 100644 --- a/src/lib/tabs/index.ts +++ b/src/lib/tabs/index.ts @@ -18,9 +18,26 @@ import {SCROLL_DISPATCHER_PROVIDER} from '../core/overlay/scroll/scroll-dispatch @NgModule({ imports: [CommonModule, PortalModule, MdRippleModule, ObserveContentModule], // Don't export all components because some are only to be used internally. - exports: [MdTabGroup, MdTabLabel, MdTab, MdTabNavBar, MdTabLink, MdTabLinkRipple], - declarations: [MdTabGroup, MdTabLabel, MdTab, MdInkBar, MdTabLabelWrapper, - MdTabNavBar, MdTabLink, MdTabBody, MdTabLinkRipple, MdTabHeader], + exports: [ + MdTabGroup, + MdTabLabel, + MdTab, + MdTabNavBar, + MdTabLink, + MdTabLinkRipple + ], + declarations: [ + MdTabGroup, + MdTabLabel, + MdTab, + MdInkBar, + MdTabLabelWrapper, + MdTabNavBar, + MdTabLink, + MdTabBody, + MdTabLinkRipple, + MdTabHeader + ], providers: [VIEWPORT_RULER_PROVIDER, SCROLL_DISPATCHER_PROVIDER], }) export class MdTabsModule { diff --git a/src/lib/tabs/ink-bar.ts b/src/lib/tabs/ink-bar.ts index b49e234aae4a..efeadf0b4688 100644 --- a/src/lib/tabs/ink-bar.ts +++ b/src/lib/tabs/ink-bar.ts @@ -1,7 +1,10 @@ import {Directive, Renderer, ElementRef} from '@angular/core'; -/** The ink-bar is used to display and animate the line underneath the current active tab label. */ +/** + * The ink-bar is used to display and animate the line underneath the current active tab label. + * @docs-private + */ @Directive({ selector: 'md-ink-bar, mat-ink-bar', host: { diff --git a/src/lib/tabs/tab-body.ts b/src/lib/tabs/tab-body.ts index 4bc55de22cb6..416ac2ec6565 100644 --- a/src/lib/tabs/tab-body.ts +++ b/src/lib/tabs/tab-body.ts @@ -43,6 +43,7 @@ export type MdTabBodyOriginState = 'left' | 'right'; /** * Wrapper for the contents of a tab. + * @docs-private */ @Component({ moduleId: module.id, diff --git a/src/lib/tabs/tab-header.ts b/src/lib/tabs/tab-header.ts index 46724d7aacf5..36fa3bf61dbf 100644 --- a/src/lib/tabs/tab-header.ts +++ b/src/lib/tabs/tab-header.ts @@ -37,6 +37,7 @@ const EXAGGERATED_OVERSCROLL = 60; * an ink bar that follows the currently selected tab. When the tabs list's width exceeds the * width of the header container, then arrows will be displayed to allow the user to scroll * left and right across the header. + * @docs-private */ @Component({ moduleId: module.id, diff --git a/src/lib/tabs/tab-label-wrapper.ts b/src/lib/tabs/tab-label-wrapper.ts index b60638ff99dc..d3fd75d9ee30 100644 --- a/src/lib/tabs/tab-label-wrapper.ts +++ b/src/lib/tabs/tab-label-wrapper.ts @@ -2,7 +2,10 @@ import {Directive, ElementRef, Renderer, Input} from '@angular/core'; import {coerceBooleanProperty} from '../core/coercion/boolean-property'; -/** Used in the `md-tab-group` view to display tab labels */ +/** + * Used in the `md-tab-group` view to display tab labels. + * @docs-private + */ @Directive({ selector: '[md-tab-label-wrapper], [mat-tab-label-wrapper]', host: {