docs: add api stability indicators for @angular/common

This commit is contained in:
Igor Minar
2016-05-27 11:24:05 -07:00
parent 1c929031a2
commit 7bc2d9a93a
48 changed files with 128 additions and 24 deletions
@@ -45,6 +45,8 @@ import {UrlChangeListener, PlatformLocation} from './platform_location';
* provide(LocationStrategy, {useClass: HashLocationStrategy})
* ]);
* ```
*
* @stable
*/
@Injectable()
export class HashLocationStrategy extends LocationStrategy {
@@ -42,6 +42,8 @@ import {LocationStrategy} from './location_strategy';
*
* bootstrap(AppCmp, [ROUTER_PROVIDERS]);
* ```
*
* @stable
*/
@Injectable()
export class Location {
@@ -16,6 +16,8 @@ import {UrlChangeListener} from './platform_location';
* `http://example.com/foo` as an equivalent URL.
*
* See these two classes for more.
*
* @stable
*/
export abstract class LocationStrategy {
abstract path(): string;
@@ -57,5 +59,6 @@ export abstract class LocationStrategy {
* provide(APP_BASE_HREF, {useValue: '/my/app'})
* ]);
* ```
* @stable
*/
export const APP_BASE_HREF: OpaqueToken = /*@ts2dart_const*/ new OpaqueToken('appBaseHref');
@@ -53,6 +53,8 @@ import {Location} from './location';
* provide(APP_BASE_HREF, {useValue: '/my/app'})
* ]);
* ```
*
* @stable
*/
@Injectable()
export class PathLocationStrategy extends LocationStrategy {
@@ -21,6 +21,8 @@
* {@link Location} / {@link LocationStrategy} and DOM apis flow through the `PlatformLocation`
* class
* they are all platform independent.
*
* @stable
*/
export abstract class PlatformLocation {
abstract getBaseHrefFromDOM(): string;
@@ -42,6 +44,8 @@ export abstract class PlatformLocation {
/**
* A serializable version of the event from onPopState or onHashChange
*
* @stable
*/
export interface UrlChangeEvent { type: string; }