Skip to content

Commit

Permalink
fix(lib): remove all uses of @internal
Browse files Browse the repository at this point in the history
  • Loading branch information
ThomasBurleson committed Jan 5, 2017
1 parent fff9bf6 commit ca64760
Show file tree
Hide file tree
Showing 8 changed files with 6 additions and 20 deletions.
2 changes: 0 additions & 2 deletions src/lib/flexbox/api/base.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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}).
*/
Expand Down
5 changes: 0 additions & 5 deletions src/lib/flexbox/responsive/responsive-activation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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.
Expand Down
2 changes: 0 additions & 2 deletions src/lib/media-query/breakpoints/break-point-registry.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
Expand Down
1 change: 1 addition & 0 deletions src/lib/media-query/index.ts
Original file line number Diff line number Diff line change
@@ -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';
Expand Down
2 changes: 0 additions & 2 deletions src/lib/media-query/match-media.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand All @@ -20,7 +19,6 @@ export interface MediaQueryListListener {
}

/**
* @internal
* EventDispatcher for a specific mediaQuery [range]
*/
export interface MediaQueryList {
Expand Down
2 changes: 0 additions & 2 deletions src/lib/utils/add-alias.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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).
*/
Expand Down
10 changes: 5 additions & 5 deletions src/lib/utils/auto-prefixer.ts
Original file line number Diff line number Diff line change
@@ -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) {

Expand Down Expand Up @@ -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();
Expand Down
2 changes: 0 additions & 2 deletions src/lib/utils/object-extend.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
/**
* @internal
*
* Extends an object with the *enumerable* and *own* properties of one or more source objects,
* similar to Object.assign.
*
Expand Down

0 comments on commit ca64760

Please sign in to comment.