From ca647603c77f72d8c4e2542a5a1e65cc3d2c9cb8 Mon Sep 17 00:00:00 2001 From: Thomas Burleson Date: Thu, 5 Jan 2017 15:07:16 -0600 Subject: [PATCH] fix(lib): remove all uses of @internal --- src/lib/flexbox/api/base.ts | 2 -- src/lib/flexbox/responsive/responsive-activation.ts | 5 ----- .../media-query/breakpoints/break-point-registry.ts | 2 -- src/lib/media-query/index.ts | 1 + src/lib/media-query/match-media.ts | 2 -- src/lib/utils/add-alias.ts | 2 -- src/lib/utils/auto-prefixer.ts | 10 +++++----- src/lib/utils/object-extend.ts | 2 -- 8 files changed, 6 insertions(+), 20 deletions(-) diff --git a/src/lib/flexbox/api/base.ts b/src/lib/flexbox/api/base.ts index f66747c51..2d5abf7e8 100644 --- a/src/lib/flexbox/api/base.ts +++ b/src/lib/flexbox/api/base.ts @@ -6,8 +6,6 @@ import {MediaMonitor} from '../../media-query/media-monitor'; import {MediaQuerySubscriber} from '../../media-query/media-change'; /** - * @internal - * * Definition of a css style. Either a property name (e.g. "flex-basis") or an object * map of property name and value (e.g. {display: 'none', flex-order: 5}). */ diff --git a/src/lib/flexbox/responsive/responsive-activation.ts b/src/lib/flexbox/responsive/responsive-activation.ts index ddf86b636..e86d04373 100644 --- a/src/lib/flexbox/responsive/responsive-activation.ts +++ b/src/lib/flexbox/responsive/responsive-activation.ts @@ -6,16 +6,13 @@ import {MediaChange, MediaQuerySubscriber} from '../../media-query/media-change' import {BreakPoint} from '../../media-query/breakpoints/break-point'; import {MediaMonitor} from '../../media-query/media-monitor'; -/** @internal */ export declare type SubscriptionList = Subscription[ ]; -/** @internal */ export interface BreakPointX extends BreakPoint { key: string; baseKey: string; } -/** @internal */ export class KeyOptions { constructor(public baseKey: string, public defaultValue: string|number|boolean, @@ -24,8 +21,6 @@ export class KeyOptions { } /** - * @internal - * * ResponsiveActivation acts as a proxy between the MonitorMedia service (which emits mediaQuery * changes) and the fx API directives. The MQA proxies mediaQuery change events and notifies the * directive via the specified callback. diff --git a/src/lib/media-query/breakpoints/break-point-registry.ts b/src/lib/media-query/breakpoints/break-point-registry.ts index b5bf82bca..65a74b6fd 100644 --- a/src/lib/media-query/breakpoints/break-point-registry.ts +++ b/src/lib/media-query/breakpoints/break-point-registry.ts @@ -4,8 +4,6 @@ import {BreakPoint} from './break-point'; import {BREAKPOINTS} from "../providers/break-points-provider"; /** - * @internal - * * Registry of 1..n MediaQuery breakpoint ranges * This is published as a provider and may be overriden from custom, application-specific ranges * diff --git a/src/lib/media-query/index.ts b/src/lib/media-query/index.ts index a091a15ce..f7308c898 100644 --- a/src/lib/media-query/index.ts +++ b/src/lib/media-query/index.ts @@ -1,5 +1,6 @@ export * from './breakpoints/break-point-registry'; export * from './providers/break-points-provider'; +export * from './providers/match-media-observable-provider'; export * from './match-media'; export * from './media-change'; export * from './media-monitor'; diff --git a/src/lib/media-query/match-media.ts b/src/lib/media-query/match-media.ts index 85e24de0b..9763ae387 100644 --- a/src/lib/media-query/match-media.ts +++ b/src/lib/media-query/match-media.ts @@ -11,7 +11,6 @@ import 'rxjs/add/operator/map'; import {MediaChange} from './media-change'; /** - * @internal * EventHandler callback with the mediaQuery [range] activates or deactivates */ export interface MediaQueryListListener { @@ -20,7 +19,6 @@ export interface MediaQueryListListener { } /** - * @internal * EventDispatcher for a specific mediaQuery [range] */ export interface MediaQueryList { diff --git a/src/lib/utils/add-alias.ts b/src/lib/utils/add-alias.ts index 8aa581220..fe8efd785 100644 --- a/src/lib/utils/add-alias.ts +++ b/src/lib/utils/add-alias.ts @@ -3,8 +3,6 @@ import {BreakPoint} from '../media-query/breakpoints/break-point'; import {extendObject} from './object-extend'; /** - * @internal - * * For the specified MediaChange, make sure it contains the breakpoint alias * and suffix (if available). */ diff --git a/src/lib/utils/auto-prefixer.ts b/src/lib/utils/auto-prefixer.ts index 7aa91f06d..df1f99aa3 100644 --- a/src/lib/utils/auto-prefixer.ts +++ b/src/lib/utils/auto-prefixer.ts @@ -1,4 +1,4 @@ -/** @internal Applies CSS prefixes to appropriate style keys.*/ +/** Applies CSS prefixes to appropriate style keys.*/ export function applyCssPrefixes(target) { for (let key in target) { @@ -70,23 +70,23 @@ export function toAlignContentValue(value: string) { } } -/** @internal Convert flex values flex-start, flex-end to start, end. */ +/** Convert flex values flex-start, flex-end to start, end. */ export function toBoxValue(value = "") { return (value == 'flex-start') ? 'start' : ((value == 'flex-end') ? 'end' : value); } -/** @internal Convert flex Direction to Box orientation */ +/** Convert flex Direction to Box orientation */ export function toBoxOrient(flexDirection = 'row') { return flexDirection.indexOf('column') === -1 ? 'horizontal' : 'vertical'; } -/** @internal Convert flex Direction to Box direction type */ +/** Convert flex Direction to Box direction type */ export function toBoxDirection(flexDirection = 'row') { return flexDirection.indexOf('reverse') !== -1 ? 'reverse' : 'normal'; } -/** @internal Convert flex order to Box ordinal group */ +/** Convert flex order to Box ordinal group */ export function toBoxOrdinal(order = '0') { let value = order ? parseInt(order) + 1 : 1; return isNaN(value) ? "0" : value.toString(); diff --git a/src/lib/utils/object-extend.ts b/src/lib/utils/object-extend.ts index 348700dfa..168b8d84a 100644 --- a/src/lib/utils/object-extend.ts +++ b/src/lib/utils/object-extend.ts @@ -1,6 +1,4 @@ /** - * @internal - * * Extends an object with the *enumerable* and *own* properties of one or more source objects, * similar to Object.assign. *