docs: common with @publicApi tags (#26595)

PR Close #26595
This commit is contained in:
Pete Bacon Darwin
2018-10-19 15:06:08 +01:00
committed by Alex Rickabaugh
parent 42c331bbf2
commit 0918adf39d
43 changed files with 87 additions and 97 deletions

View File

@ -31,7 +31,7 @@ import {LocationChangeListener, PlatformLocation} from './platform_location';
*
* {@example common/location/ts/hash_location_component.ts region='LocationComponent'}
*
*
* @publicApi
*/
@Injectable()
export class HashLocationStrategy extends LocationStrategy {

View File

@ -44,6 +44,7 @@ export interface PopStateEvent {
*
* {@example common/location/ts/path_location_component.ts region='LocationComponent'}
*
* @publicApi
*/
@Injectable()
export class Location {

View File

@ -25,7 +25,7 @@ import {LocationChangeListener} from './platform_location';
*
* See these two classes for more.
*
*
* @publicApi
*/
export abstract class LocationStrategy {
abstract path(includeHash?: boolean): string;
@ -61,6 +61,6 @@ export abstract class LocationStrategy {
* class AppModule {}
* ```
*
*
* @publicApi
*/
export const APP_BASE_HREF = new InjectionToken<string>('appBaseHref');

View File

@ -40,7 +40,7 @@ import {LocationChangeListener, PlatformLocation} from './platform_location';
*
* {@example common/location/ts/path_location_component.ts region='LocationComponent'}
*
*
* @publicApi
*/
@Injectable()
export class PathLocationStrategy extends LocationStrategy {

View File

@ -27,7 +27,7 @@ import {InjectionToken} from '@angular/core';
* {@link Location} / {@link LocationStrategy} and DOM apis flow through the `PlatformLocation`
* class they are all platform independent.
*
*
* @publicApi
*/
export abstract class PlatformLocation {
abstract getBaseHrefFromDOM(): string;
@ -48,7 +48,9 @@ export abstract class PlatformLocation {
}
/**
* @description Indicates when a location is initialized.
* @description
* Indicates when a location is initialized.
*
* @publicApi
*/
export const LOCATION_INITIALIZED = new InjectionToken<Promise<any>>('Location Initialized');