docs: convert all @experimental tags to @publicApi tags (#26595)

PR Close #26595
This commit is contained in:
Pete Bacon Darwin
2018-10-19 12:12:20 +01:00
committed by Alex Rickabaugh
parent 4bd9f53e8f
commit 24521f549c
116 changed files with 331 additions and 331 deletions

View File

@ -34,7 +34,7 @@ export const INTERNAL_BROWSER_PLATFORM_PROVIDERS: StaticProvider[] = [
* @security Replacing built-in sanitization providers exposes the application to XSS risks.
* Attacker-controlled data introduced by an unsanitized provider could expose your
* application to XSS risks. For more detail, see the [Security Guide](http://g.co/ng/security).
* @experimental
* @publicApi
*/
export const BROWSER_SANITIZATION_PROVIDERS: StaticProvider[] = [
{provide: Sanitizer, useExisting: DomSanitizer},
@ -114,7 +114,7 @@ export class BrowserModule {
* The ID must match between the client and server versions of the app.
* @returns The reconfigured `BrowserModule` to import into the app's root `AppModule`.
*
* @experimental
* @publicApi
*/
static withServerTransition(params: {appId: string}): ModuleWithProviders<BrowserModule> {
return {

View File

@ -16,7 +16,7 @@ import {DOCUMENT} from '../dom/dom_tokens';
/**
* Represents a meta element.
*
* @experimental
* @publicApi
*/
export type MetaDefinition = {
charset?: string; content?: string; httpEquiv?: string; id?: string; itemprop?: string;
@ -40,7 +40,7 @@ export function createMeta() {
/**
* A service that can be used to get and add meta tags.
*
* @experimental
* @publicApi
*/
@Injectable({providedIn: 'root', useFactory: createMeta, deps: []})
export class Meta {

View File

@ -26,7 +26,7 @@ export function createTitle() {
* (representing the `<title>` tag). Instead, this service can be used to set and get the current
* title value.
*
* @experimental
* @publicApi
*/
@Injectable({providedIn: 'root', useFactory: createTitle, deps: []})
export class Title {

View File

@ -23,7 +23,7 @@ const PROFILER_GLOBAL_NAME = 'profiler';
* 1. Try the change detection profiler `ng.profiler.timeChangeDetection()`
* then hit Enter.
*
* @experimental All debugging apis are currently experimental.
* @publicApi
*/
export function enableDebugTools<T>(ref: ComponentRef<T>): ComponentRef<T> {
exportNgVar(PROFILER_GLOBAL_NAME, new AngularProfiler(ref));
@ -33,7 +33,7 @@ export function enableDebugTools<T>(ref: ComponentRef<T>): ComponentRef<T> {
/**
* Disables Angular tools.
*
* @experimental All debugging apis are currently experimental.
* @publicApi
*/
export function disableDebugTools(): void {
exportNgVar(PROFILER_GLOBAL_NAME, null);

View File

@ -43,7 +43,7 @@ export function unescapeHtml(text: string): string {
* transferState.set(COUNTER_KEY, value);
* ```
*
* @experimental
* @publicApi
*/
export type StateKey<T> = string & {__not_a_string: never};
@ -59,7 +59,7 @@ export type StateKey<T> = string & {__not_a_string: never};
* transferState.set(COUNTER_KEY, value);
* ```
*
* @experimental
* @publicApi
*/
export function makeStateKey<T = void>(key: string): StateKey<T> {
return key as StateKey<T>;
@ -76,7 +76,7 @@ export function makeStateKey<T = void>(key: string): StateKey<T> {
* boolean, number, string, null and non-class objects will be serialized and deserialzied in a
* non-lossy manner.
*
* @experimental
* @publicApi
*/
@Injectable()
export class TransferState {
@ -156,7 +156,7 @@ export function initTransferState(doc: Document, appId: string) {
* NgModule to install on the client side while using the `TransferState` to transfer state from
* server to client.
*
* @experimental
* @publicApi
*/
@NgModule({
providers: [{provide: TransferState, useFactory: initTransferState, deps: [DOCUMENT, APP_ID]}],

View File

@ -14,7 +14,7 @@ import {getDOM} from '../../dom/dom_adapter';
/**
* Predicates for use with {@link DebugElement}'s query functions.
*
* @experimental All debugging apis are currently experimental.
* @publicApi
*/
export class By {
/**

View File

@ -57,7 +57,7 @@ const EVENT_NAMES = {
* DI token for providing [HammerJS](http://hammerjs.github.io/) support to Angular.
* @see `HammerGestureConfig`
*
* @experimental
* @publicApi
*/
export const HAMMER_GESTURE_CONFIG = new InjectionToken<HammerGestureConfig>('HammerGestureConfig');
@ -77,7 +77,7 @@ export interface HammerInstance {
/**
* An injectable [HammerJS Manager](http://hammerjs.github.io/api/#hammer.manager)
* for gesture recognition. Configures specific event recognition.
* @experimental
* @publicApi
*/
@Injectable()
export class HammerGestureConfig {

View File

@ -29,7 +29,7 @@ const MODIFIER_KEY_GETTERS: {[key: string]: (event: KeyboardEvent) => boolean} =
};
/**
* @experimental
* @publicApi
* A browser plug-in that provides support for handling of key events in Angular.
*/
@Injectable()