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

@ -65,6 +65,7 @@ const _observableStrategy = new ObservableStrategy();
*
* {@example common/pipes/ts/async_pipe.ts region='AsyncPipeObservable'}
*
* @publicApi
*/
@Pipe({name: 'async', pure: false})
export class AsyncPipe implements OnDestroy, PipeTransform {

View File

@ -22,6 +22,7 @@ import {invalidPipeArgumentError} from './invalid_pipe_argument_error';
* <code-example path="common/pipes/ts/lowerupper_pipe.ts" region='LowerUpperPipe'></code-example>
*
* @ngModule CommonModule
* @publicApi
*/
@Pipe({name: 'lowercase'})
export class LowerCasePipe implements PipeTransform {
@ -64,6 +65,7 @@ const unicodeWordMatch =
* <code-example path="common/pipes/ts/titlecase_pipe.ts" region='TitleCasePipe'></code-example>
*
* @ngModule CommonModule
* @publicApi
*/
@Pipe({name: 'titlecase'})
export class TitleCasePipe implements PipeTransform {
@ -87,6 +89,7 @@ export class TitleCasePipe implements PipeTransform {
* @see `TitleCasePipe`
*
* @ngModule CommonModule
* @publicApi
*/
@Pipe({name: 'uppercase'})
export class UpperCasePipe implements PipeTransform {

View File

@ -147,6 +147,7 @@ import {invalidPipeArgumentError} from './invalid_pipe_argument_error';
* }
* ```
*
* @publicApi
*/
// clang-format on
@Pipe({name: 'date', pure: true})

View File

@ -73,7 +73,7 @@ import {DateFormatter} from './intl';
*
* {@example common/pipes/ts/date_pipe.ts region='DeprecatedDatePipe'}
*
*
* @publicApi
*/
@Pipe({name: 'date', pure: true})
export class DeprecatedDatePipe implements PipeTransform {

View File

@ -83,6 +83,7 @@ function formatNumber(
* {@example common/pipes/ts/number_pipe.ts region='DeprecatedNumberPipe'}
*
* @ngModule CommonModule
* @publicApi
*/
@Pipe({name: 'number'})
export class DeprecatedDecimalPipe implements PipeTransform {
@ -112,7 +113,7 @@ export class DeprecatedDecimalPipe implements PipeTransform {
*
* {@example common/pipes/ts/percent_pipe.ts region='DeprecatedPercentPipe'}
*
*
* @publicApi
*/
@Pipe({name: 'percent'})
export class DeprecatedPercentPipe implements PipeTransform {
@ -148,7 +149,7 @@ export class DeprecatedPercentPipe implements PipeTransform {
*
* {@example common/pipes/ts/currency_pipe.ts region='DeprecatedCurrencyPipe'}
*
*
* @publicApi
*/
@Pipe({name: 'currency'})
export class DeprecatedCurrencyPipe implements PipeTransform {

View File

@ -21,6 +21,7 @@ import {Pipe, PipeTransform} from '@angular/core';
*
* {@example common/pipes/ts/json_pipe.ts region='JsonPipe'}
*
* @publicApi
*/
@Pipe({name: 'json', pure: false})
export class JsonPipe implements PipeTransform {

View File

@ -15,6 +15,8 @@ function makeKeyValuePair<K, V>(key: K, value: V): KeyValue<K, V> {
/**
* A key value pair.
* Usually used to represent the key value pairs from a Map or Object.
*
* @publicApi
*/
export interface KeyValue<K, V> {
key: K;
@ -38,6 +40,8 @@ export interface KeyValue<K, V> {
* pipe.
*
* {@example common/pipes/ts/keyvalue_pipe.ts region='KeyValuePipe'}
*
* @publicApi
*/
@Pipe({name: 'keyvalue', pure: false})
export class KeyValuePipe implements PipeTransform {

View File

@ -44,6 +44,7 @@ import {invalidPipeArgumentError} from './invalid_pipe_argument_error';
*
* <code-example path="common/pipes/ts/number_pipe.ts" region='NumberPipe'></code-example>
*
* @publicApi
*/
@Pipe({name: 'number'})
export class DecimalPipe implements PipeTransform {
@ -96,7 +97,7 @@ export class DecimalPipe implements PipeTransform {
*
* <code-example path="common/pipes/ts/percent_pipe.ts" region='PercentPipe'></code-example>
*
*
* @publicApi
*/
@Pipe({name: 'percent'})
export class PercentPipe implements PipeTransform {
@ -150,7 +151,7 @@ export class PercentPipe implements PipeTransform {
*
* <code-example path="common/pipes/ts/currency_pipe.ts" region='CurrencyPipe'></code-example>
*
*
* @publicApi
*/
@Pipe({name: 'currency'})
export class CurrencyPipe implements PipeTransform {

View File

@ -42,8 +42,8 @@ import {invalidPipeArgumentError} from './invalid_pipe_argument_error';
*
* {@example common/pipes/ts/slice_pipe.ts region='SlicePipe_string'}
*
* @publicApi
*/
@Pipe({name: 'slice', pure: false})
export class SlicePipe implements PipeTransform {
/**