docs: misc fixes.

docs(common_module): Fix macro format
docs(number_pipe): Add missing period sign
docs(date_pipe): Fix suffix consistency
docs(date_pipe): Fix missing quote
docs(number_pipe): Fix incorrect article

Looks like the word "Polyfill" does not start with a vowel pronunciation.

docs(location_strategy): Fix code format

Add missing \`\`\` at start.

docs(i18n_plural_pipe): Fix code format
docs(location): Add missing period sign
refactor(ngSwitch): fix typo on parameter
docs(di): Add missing quote
docs(compiler): Fix typo
docs(compiler): Add missing period sign
docs(directives): Fix description for styles parameter
docs(location_strategy): Add code language

Revert for misunderstanding.
This commit is contained in:
Trotyl Yu 2016-09-05 21:37:21 +08:00 committed by Martin Probst
parent 645108f25b
commit dd03bf12e1
9 changed files with 15 additions and 14 deletions

View File

@ -15,7 +15,7 @@ import {COMMON_PIPES} from './pipes/common_pipes';
// Note: This does not contain the location providers,
// as they need some platform specific implementations to work.
/**
* The module that includes all the basic Angular directives like {@link NgIf}, ${link NgFor}, ...
* The module that includes all the basic Angular directives like {@link NgIf}, {@link NgFor}, ...
*
* @stable
*/

View File

@ -79,7 +79,7 @@ export class Location {
/**
* Given a string representing a URL, returns the normalized URL path without leading or
* trailing slashes
* trailing slashes.
*/
normalize(url: string): string {
return Location.stripTrailingSlash(_stripBaseHref(this._baseHref, _stripIndexHtml(url)));

View File

@ -49,6 +49,7 @@ export abstract class LocationStrategy {
*
* ### Example
*
* ```typescript
* import {Component, NgModule} from '@angular/core';
* import {APP_BASE_HREF} from '@angular/common';
*

View File

@ -57,13 +57,13 @@ import {InvalidPipeArgumentError} from './invalid_pipe_argument_error';
* - `'medium'`: equivalent to `'yMMMdjms'` (e.g. Sep 3, 2010, 12:05:08 PM for en-US)
* - `'short'`: equivalent to `'yMdjm'` (e.g. 9/3/2010, 12:05 PM for en-US)
* - `'fullDate'`: equivalent to `'yMMMMEEEEd'` (e.g. Friday, September 3, 2010 for en-US)
* - `'longDate'`: equivalent to `'yMMMMd'` (e.g. September 3, 2010)
* - `'longDate'`: equivalent to `'yMMMMd'` (e.g. September 3, 2010 for en-US)
* - `'mediumDate'`: equivalent to `'yMMMd'` (e.g. Sep 3, 2010 for en-US)
* - `'shortDate'`: equivalent to `'yMd'` (e.g. 9/3/2010 for en-US)
* - `'mediumTime'`: equivalent to `'jms'` (e.g. 12:05:08 PM for en-US)
* - `'shortTime'`: equivalent to `'jm'` (e.g. 12:05 PM for en-US)
*
* Timezone of the formatted text will be the local system timezone of the end-users machine.
* Timezone of the formatted text will be the local system timezone of the end-user's machine.
*
* ### Examples
*

View File

@ -18,7 +18,7 @@ const _INTERPOLATION_REGEXP: RegExp = /#/g;
*
* ## Usage
*
* expression | i18nPlural:mapping
* expression | i18nPlural:mapping
*
* where `expression` is a number and `mapping` is an object that mimics the ICU format,
* see http://userguide.icu-project.org/formatparse/messages

View File

@ -60,7 +60,7 @@ function formatNumber(
/**
* WARNING: this pipe uses the Internationalization API.
* Therefore it is only reliable in Chrome and Opera browsers. For other browsers please use an
* Therefore it is only reliable in Chrome and Opera browsers. For other browsers please use a
* polyfill, for example: [https://github.com/andyearnshaw/Intl.js/].
*
* Formats a number as local text. i.e. group sizing and separator and other locale-specific
@ -98,7 +98,7 @@ export class DecimalPipe implements PipeTransform {
/**
* WARNING: this pipe uses the Internationalization API.
* Therefore it is only reliable in Chrome and Opera browsers. For other browsers please use an
* Therefore it is only reliable in Chrome and Opera browsers. For other browsers please use a
* polyfill, for example: [https://github.com/andyearnshaw/Intl.js/].
*
* Formats a number as local percent.
@ -126,7 +126,7 @@ export class PercentPipe implements PipeTransform {
/**
* WARNING: this pipe uses the Internationalization API.
* Therefore it is only reliable in Chrome and Opera browsers. For other browsers please use an
* Therefore it is only reliable in Chrome and Opera browsers. For other browsers please use a
* polyfill, for example: [https://github.com/andyearnshaw/Intl.js/].
*
*
@ -140,7 +140,7 @@ export class PercentPipe implements PipeTransform {
* "EUR" for the euro. `symbolDisplay` is a boolean indicating whether to use the currency
* symbol (e.g. $) or the currency code (e.g. USD) in the output. The default for this value
* is `false`.
* For more information about `digitInfo` see {@link DecimalPipe}
* For more information about `digitInfo` see {@link DecimalPipe}.
*
* ### Example
*

View File

@ -68,14 +68,14 @@ export class Compiler {
compileModuleAsync<T>(moduleType: Type<T>): Promise<NgModuleFactory<T>> { throw _throwError(); }
/**
* Same as {@link compileModuleSync} put 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} put 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>> {
@ -83,7 +83,7 @@ export class Compiler {
}
/**
* Clears all caches
* Clears all caches.
*/
clearCache(): void {}

View File

@ -35,7 +35,7 @@ import {Type} from '../type';
* // user code
* let routes = [
* {path: '/root', component: RootComp},
* {path: /teams', component: TeamsComp}
* {path: '/teams', component: TeamsComp}
* ];
*
* @NgModule({

View File

@ -883,7 +883,7 @@ export class ComponentMetadata extends DirectiveMetadata implements ComponentMet
styleUrls: string[];
/**
* Specifies an inline stylesheet for an Angular component.
* Specifies inline stylesheets for an Angular component.
*/
styles: string[];