docs: fix links in api docs
This commit is contained in:

committed by
Pete Bacon Darwin

parent
5ba8c14893
commit
71f5b73296
@ -162,8 +162,8 @@ export function getPlatform(): PlatformRef|null {
|
||||
* has exactly one platform, and services (such as reflection) which are common
|
||||
* to every Angular application running on the page are bound in its scope.
|
||||
*
|
||||
* A page's platform is initialized implicitly when {@link bootstrap}() is called, or
|
||||
* explicitly by calling {@link createPlatform}().
|
||||
* A page's platform is initialized implicitly when a platform is created via a platform factory
|
||||
* (e.g. {@link platformBrowser}), or explicitly by calling the {@link createPlatform} function.
|
||||
*
|
||||
* @stable
|
||||
*/
|
||||
@ -344,8 +344,6 @@ export class PlatformRef_ extends PlatformRef {
|
||||
/**
|
||||
* A reference to an Angular application running on a page.
|
||||
*
|
||||
* For more about Angular applications, see the documentation for {@link bootstrap}.
|
||||
*
|
||||
* @stable
|
||||
*/
|
||||
export abstract class ApplicationRef {
|
||||
|
@ -50,7 +50,7 @@ export abstract class Injector {
|
||||
/**
|
||||
* Retrieves an instance from the injector based on the provided token.
|
||||
* If not found:
|
||||
* - Throws {@link NoProviderError} if no `notFoundValue` that is not equal to
|
||||
* - Throws an error if no `notFoundValue` that is not equal to
|
||||
* Injector.THROW_IF_NOT_FOUND is given
|
||||
* - Returns the `notFoundValue` otherwise
|
||||
*/
|
||||
|
@ -54,14 +54,14 @@ export class Compiler {
|
||||
compileModuleAsync<T>(moduleType: Type<T>): Promise<NgModuleFactory<T>> { throw _throwError(); }
|
||||
|
||||
/**
|
||||
* Same as {@link compileModuleSync} but also creates ComponentFactories for all components.
|
||||
* Same as {@link #compileModuleSync} but also creates ComponentFactories for all components.
|
||||
*/
|
||||
compileModuleAndAllComponentsSync<T>(moduleType: Type<T>): ModuleWithComponentFactories<T> {
|
||||
throw _throwError();
|
||||
}
|
||||
|
||||
/**
|
||||
* Same as {@link compileModuleAsync} but also creates ComponentFactories for all components.
|
||||
* Same as {@link #compileModuleAsync} but also creates ComponentFactories for all components.
|
||||
*/
|
||||
compileModuleAndAllComponentsAsync<T>(moduleType: Type<T>):
|
||||
Promise<ModuleWithComponentFactories<T>> {
|
||||
|
@ -16,7 +16,8 @@ import {getSymbolIterator} from '../util';
|
||||
* An unmodifiable list of items that Angular keeps up to date when the state
|
||||
* of the application changes.
|
||||
*
|
||||
* The type of object that {@link Query} and {@link ViewQueryMetadata} provide.
|
||||
* The type of object that {@link ViewChildren}, {@link ContentChildren}, and {@link QueryList}
|
||||
* provide.
|
||||
*
|
||||
* Implements an iterable interface, therefore it can be used in both ES6
|
||||
* javascript `for (var i of items)` loops as well as in Angular templates with
|
||||
|
@ -287,7 +287,7 @@ export const ContentChild: ContentChildDecorator = makePropDecorator(
|
||||
/**
|
||||
* Type of the ViewChildren decorator / constructor function.
|
||||
*
|
||||
* See {@ViewChildren}.
|
||||
* See {@link ViewChildren}.
|
||||
*
|
||||
* @stable
|
||||
*/
|
||||
|
@ -662,8 +662,8 @@ export interface Component extends Directive {
|
||||
* encapsulation.
|
||||
*
|
||||
* When no `encapsulation` is defined for the component, the default value from the
|
||||
* {@link CompilerConfig} is used. The default is `ViewEncapsulation.Emulated`}. Provide a new
|
||||
* `CompilerConfig` to override this value.
|
||||
* {@link CompilerOptions} is used. The default is `ViewEncapsulation.Emulated`}. Provide a new
|
||||
* `CompilerOptions` to override this value.
|
||||
*
|
||||
* If the encapsulation is set to `ViewEncapsulation.Emulated` and the component has no `styles`
|
||||
* nor `styleUrls` the encapsulation will automatically be switched to `ViewEncapsulation.None`.
|
||||
|
@ -9,14 +9,14 @@
|
||||
/**
|
||||
* Defines template and style encapsulation options available for Component's {@link Component}.
|
||||
*
|
||||
* See {@link ViewMetadata#encapsulation}.
|
||||
* See {@link Component#encapsulation}.
|
||||
* @stable
|
||||
*/
|
||||
export enum ViewEncapsulation {
|
||||
/**
|
||||
* Emulate `Native` scoping of styles by adding an attribute containing surrogate id to the Host
|
||||
* Element and pre-processing the style rules provided via
|
||||
* {@link ViewMetadata#styles} or {@link ViewMetadata#stylesUrls}, and adding the new Host Element
|
||||
* {@link Component#styles} or {@link Component#styleUrls}, and adding the new Host Element
|
||||
* attribute to all selectors.
|
||||
*
|
||||
* This is the default option.
|
||||
|
@ -13,8 +13,8 @@ import {EventEmitter} from '../event_emitter';
|
||||
*
|
||||
* The most common use of this service is to optimize performance when starting a work consisting of
|
||||
* one or more asynchronous tasks that don't require UI updates or error handling to be handled by
|
||||
* Angular. Such tasks can be kicked off via {@link runOutsideAngular} and if needed, these tasks
|
||||
* can reenter the Angular zone via {@link run}.
|
||||
* Angular. Such tasks can be kicked off via {@link #runOutsideAngular} and if needed, these tasks
|
||||
* can reenter the Angular zone via {@link #run}.
|
||||
*
|
||||
* <!-- TODO: add/fix links to:
|
||||
* - docs explaining zones and the use of zones in Angular and change-detection
|
||||
@ -132,7 +132,7 @@ export class NgZone {
|
||||
* the function.
|
||||
*
|
||||
* Running functions via `run` allows you to reenter Angular zone from a task that was executed
|
||||
* outside of the Angular zone (typically started via {@link runOutsideAngular}).
|
||||
* outside of the Angular zone (typically started via {@link #runOutsideAngular}).
|
||||
*
|
||||
* Any future tasks or microtasks scheduled from within this function will continue executing from
|
||||
* within the Angular zone.
|
||||
@ -151,13 +151,14 @@ export class NgZone {
|
||||
* Executes the `fn` function synchronously in Angular's parent zone and returns value returned by
|
||||
* the function.
|
||||
*
|
||||
* Running functions via `runOutsideAngular` allows you to escape Angular's zone and do work that
|
||||
* Running functions via {@link #runOutsideAngular} allows you to escape Angular's zone and do
|
||||
* work that
|
||||
* doesn't trigger Angular change-detection or is subject to Angular's error handling.
|
||||
*
|
||||
* Any future tasks or microtasks scheduled from within this function will continue executing from
|
||||
* outside of the Angular zone.
|
||||
*
|
||||
* Use {@link run} to reenter the Angular zone and do work that updates the application model.
|
||||
* Use {@link #run} to reenter the Angular zone and do work that updates the application model.
|
||||
*/
|
||||
runOutsideAngular(fn: () => any): any { return this.outer.run(fn); }
|
||||
|
||||
|
Reference in New Issue
Block a user