Skip to content

Commit

Permalink
fixup! docs: remove all deprecated @stable jsdoc tags
Browse files Browse the repository at this point in the history 
These are no longer needed as stable docs are computed as those that
do not have `@experimental` or `@deprecated` tags.
  • Loading branch information
@petebacondarwin
petebacondarwin committed Apr 10, 2018
1 parent e136c2d commit 2503163
Show file tree
Hide file tree
Showing 18 changed files with 14 additions and 294 deletions.
37 changes: 0 additions & 37 deletions tools/public_api_guard/common/common.d.ts
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
/** @stable */
export declare const APP_BASE_HREF: InjectionToken<string>;

/** @stable */
export declare class AsyncPipe implements OnDestroy, PipeTransform {
constructor(_ref: ChangeDetectorRef);
ngOnDestroy(): void;
Expand All @@ -11,41 +9,34 @@ export declare class AsyncPipe implements OnDestroy, PipeTransform {
transform<T>(obj: null): null;
}

/** @stable */
export declare class CommonModule {
}

/** @stable */
export declare class CurrencyPipe implements PipeTransform {
constructor(_locale: string);
transform(value: any, currencyCode?: string, display?: 'code' | 'symbol' | 'symbol-narrow' | string | boolean, digitsInfo?: string, locale?: string): string | null;
}

/** @stable */
export declare class DatePipe implements PipeTransform {
constructor(locale: string);
transform(value: any, format?: string, timezone?: string, locale?: string): string | null;
}

/** @stable */
export declare class DecimalPipe implements PipeTransform {
constructor(_locale: string);
transform(value: any, digitsInfo?: string, locale?: string): string | null;
}

/** @stable */
export declare class DeprecatedCurrencyPipe implements PipeTransform {
constructor(_locale: string);
transform(value: any, currencyCode?: string, symbolDisplay?: boolean, digits?: string): string | null;
}

/** @stable */
export declare class DeprecatedDatePipe implements PipeTransform {
constructor(_locale: string);
transform(value: any, pattern?: string): string | null;
}

/** @stable */
export declare class DeprecatedDecimalPipe implements PipeTransform {
constructor(_locale: string);
transform(value: any, digits?: string): string | null;
Expand All @@ -55,25 +46,19 @@ export declare class DeprecatedDecimalPipe implements PipeTransform {
export declare class DeprecatedI18NPipesModule {
}

/** @stable */
export declare class DeprecatedPercentPipe implements PipeTransform {
constructor(_locale: string);
transform(value: any, digits?: string): string | null;
}

/** @stable */
export declare const DOCUMENT: InjectionToken<Document>;

/** @stable */
export declare function formatCurrency(value: number, locale: string, currency: string, currencyCode?: string, digitsInfo?: string): string;

/** @stable */
export declare function formatDate(value: string | number | Date, format: string, locale: string, timezone?: string): string;

/** @stable */
export declare function formatNumber(value: number, locale: string, digitsInfo?: string): string;

/** @stable */
export declare function formatPercent(value: number, locale: string, digitsInfo?: string): string;

/** @experimental */
Expand Down Expand Up @@ -147,7 +132,6 @@ export declare function getLocaleWeekEndRange(locale: string): [WeekDay, WeekDay
/** @experimental */
export declare function getNumberOfCurrencyDigits(code: string): number;

/** @stable */
export declare class HashLocationStrategy extends LocationStrategy {
constructor(_platformLocation: PlatformLocation, _baseHref?: string);
back(): void;
Expand Down Expand Up @@ -187,12 +171,10 @@ export declare function isPlatformWorkerApp(platformId: Object): boolean;
/** @experimental */
export declare function isPlatformWorkerUi(platformId: Object): boolean;

/** @stable */
export declare class JsonPipe implements PipeTransform {
transform(value: any): string;
}

/** @stable */
export declare class Location {
constructor(platformStrategy: LocationStrategy);
back(): void;
Expand Down Expand Up @@ -223,7 +205,6 @@ export interface LocationChangeListener {
(e: LocationChangeEvent): any;
}

/** @stable */
export declare abstract class LocationStrategy {
abstract back(): void;
abstract forward(): void;
Expand All @@ -235,12 +216,10 @@ export declare abstract class LocationStrategy {
abstract replaceState(state: any, title: string, url: string, queryParams: string): void;
}

/** @stable */
export declare class LowerCasePipe implements PipeTransform {
transform(value: string): string;
}

/** @stable */
export declare class NgClass implements DoCheck {
klass: string;
ngClass: string | string[] | Set<string> | {
Expand All @@ -261,7 +240,6 @@ export declare class NgComponentOutlet implements OnChanges, OnDestroy {
ngOnDestroy(): void;
}

/** @stable */
export declare class NgForOf<T> implements DoCheck, OnChanges {
ngForOf: NgIterable<T>;
ngForTemplate: TemplateRef<NgForOfContext<T>>;
Expand All @@ -271,7 +249,6 @@ export declare class NgForOf<T> implements DoCheck, OnChanges {
ngOnChanges(changes: SimpleChanges): void;
}

/** @stable */
export declare class NgForOfContext<T> {
$implicit: T;
count: number;
Expand All @@ -284,15 +261,13 @@ export declare class NgForOfContext<T> {
constructor($implicit: T, ngForOf: NgIterable<T>, index: number, count: number);
}

/** @stable */
export declare class NgIf {
ngIf: any;
ngIfElse: TemplateRef<NgIfContext> | null;
ngIfThen: TemplateRef<NgIfContext> | null;
constructor(_viewContainer: ViewContainerRef, templateRef: TemplateRef<NgIfContext>);
}

/** @stable */
export declare class NgIfContext {
$implicit: any;
ngIf: any;
Expand Down Expand Up @@ -325,7 +300,6 @@ export declare class NgPluralCase {
constructor(value: string, template: TemplateRef<Object>, viewContainer: ViewContainerRef, ngPlural: NgPlural);
}

/** @stable */
export declare class NgStyle implements DoCheck {
ngStyle: {
[key: string]: string;
Expand All @@ -334,24 +308,20 @@ export declare class NgStyle implements DoCheck {
ngDoCheck(): void;
}

/** @stable */
export declare class NgSwitch {
ngSwitch: any;
}

/** @stable */
export declare class NgSwitchCase implements DoCheck {
ngSwitchCase: any;
constructor(viewContainer: ViewContainerRef, templateRef: TemplateRef<Object>, ngSwitch: NgSwitch);
ngDoCheck(): void;
}

/** @stable */
export declare class NgSwitchDefault {
constructor(viewContainer: ViewContainerRef, templateRef: TemplateRef<Object>, ngSwitch: NgSwitch);
}

/** @stable */
export declare class NgTemplateOutlet implements OnChanges {
ngTemplateOutlet: TemplateRef<any>;
ngTemplateOutletContext: Object;
Expand Down Expand Up @@ -385,7 +355,6 @@ export declare enum NumberSymbol {
CurrencyGroup = 13,
}

/** @stable */
export declare class PathLocationStrategy extends LocationStrategy {
constructor(_platformLocation: PlatformLocation, href?: string);
back(): void;
Expand All @@ -398,13 +367,11 @@ export declare class PathLocationStrategy extends LocationStrategy {
replaceState(state: any, title: string, url: string, queryParams: string): void;
}

/** @stable */
export declare class PercentPipe implements PipeTransform {
constructor(_locale: string);
transform(value: any, digitsInfo?: string, locale?: string): string | null;
}

/** @stable */
export declare abstract class PlatformLocation {
readonly abstract hash: string;
readonly abstract pathname: string;
Expand Down Expand Up @@ -439,7 +406,6 @@ export interface PopStateEvent {
/** @experimental */
export declare function registerLocaleData(data: any, localeId?: string | any, extraData?: any): void;

/** @stable */
export declare class SlicePipe implements PipeTransform {
transform(value: any, start: number, end?: number): any;
}
Expand All @@ -450,7 +416,6 @@ export declare type Time = {
minutes: number;
};

/** @stable */
export declare class TitleCasePipe implements PipeTransform {
transform(value: string): string;
}
Expand All @@ -463,12 +428,10 @@ export declare enum TranslationWidth {
Short = 3,
}

/** @stable */
export declare class UpperCasePipe implements PipeTransform {
transform(value: string): string;
}

/** @stable */
export declare const VERSION: Version;

/** @experimental */
Expand Down

0 comments on commit 2503163

Please sign in to comment.