Skip to content

Commit 24b8064

Browse files
devversiontinayuangao
authored andcommitted
chore: remove ignored docs-private tags (#5353)
With #5314 a lot of `@docs-private` tags that are ignored have been added. Dgeni only includes exports of files if they are explicitly exported in a `src/XXX/index.ts` file. Since this is not the case the `@docs-private` tags can be removed because the Rx chain files are not re-exported anywhere.
1 parent 0174377 commit 24b8064

File tree

2 files changed

+1
-41
lines changed

2 files changed

+1
-41
lines changed

src/lib/core/rxjs/rx-chain.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,6 @@ import {StrictRxChain} from './rx-operators';
1616
* This class is the concrete implementation, but the type used by the user when chaining
1717
* is StrictRxChain. The strict chain enforces types on the operators to the same level as
1818
* the prototype-added equivalents.
19-
*
20-
* @docs-private
2119
*/
2220
export class RxChain<T> {
2321
private constructor(private _context: Observable<T>) { }

src/lib/core/rxjs/rx-operators.ts

Lines changed: 1 addition & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
import {Observable, ObservableInput} from 'rxjs/Observable';
1010
import {PartialObserver} from 'rxjs/Observer';
1111
import {Subscription} from 'rxjs/Subscription';
12-
import {Scheduler, IScheduler} from 'rxjs/Scheduler';
12+
import {IScheduler} from 'rxjs/Scheduler';
1313
import {_finally as _finallyOperator} from 'rxjs/operator/finally';
1414
import {_catch as _catchOperator} from 'rxjs/operator/catch';
1515
import {_do as _doOperator} from 'rxjs/operator/do';
@@ -34,8 +34,6 @@ import {takeUntil as takeUntilOperator} from 'rxjs/operator/takeUntil';
3434
*
3535
* The downside to this approach is that operators must be imported in their type-coerced form
3636
* rather than from the normal rxjs location.
37-
*
38-
* @docs-private
3937
*/
4038
export interface StrictRxChain<T> {
4139
call<R>(operator: mapOperatorType<T, R>,
@@ -78,77 +76,41 @@ export interface StrictRxChain<T> {
7876
result(): Observable<T>;
7977
}
8078

81-
// @docs-private
8279
export class FinallyBrand { private _; }
83-
// @docs-private
8480
export class CatchBrand { private _; }
85-
// @docs-private
8681
export class DoBrand { private _; }
87-
// @docs-private
8882
export class MapBrand { private _; }
89-
// @docs-private
9083
export class FilterBrand { private _; }
91-
// @docs-private
9284
export class ShareBrand { private _; }
93-
// @docs-private
9485
export class FirstBrand { private _; }
95-
// @docs-private
9686
export class SwitchMapBrand { private _; }
97-
// @docs-private
9887
export class StartWithBrand { private _; }
99-
// @docs-private
10088
export class DebounceTimeBrand { private _; }
101-
// @docs-private
10289
export class AuditTimeBrand { private _; }
103-
// @docs-private
10490
export class TakeUntilBrand { private _; }
10591

106-
// @docs-private
10792
export type finallyOperatorType<T> = typeof _finallyOperator & FinallyBrand;
108-
// @docs-private
10993
export type catchOperatorType<T, R> = typeof _catchOperator & CatchBrand;
110-
// @docs-private
11194
export type doOperatorType<T> = typeof _doOperator & DoBrand;
112-
// @docs-private
11395
export type mapOperatorType<T, R> = typeof mapOperator & MapBrand;
114-
// @docs-private
11596
export type filterOperatorType<T> = typeof filterOperator & FilterBrand;
116-
// @docs-private
11797
export type shareOperatorType<T> = typeof shareOperator & ShareBrand;
118-
// @docs-private
11998
export type firstOperatorType<T> = typeof firstOperator & FirstBrand;
120-
// @docs-private
12199
export type switchMapOperatorType<T, R> = typeof switchMapOperator & SwitchMapBrand;
122-
// @docs-private
123100
export type startWithOperatorType<T> = typeof startWithOperator & StartWithBrand;
124-
// @docs-private
125101
export type debounceTimeOperatorType<T> = typeof debounceTimeOperator & DebounceTimeBrand;
126-
// @docs-private
127102
export type auditTimeOperatorType<T> = typeof auditTimeOperator & AuditTimeBrand;
128-
// @docs-private
129103
export type takeUntilOperatorType<T> = typeof takeUntilOperator & TakeUntilBrand;
130104

131-
// @docs-private
132105
export const finallyOperator = _finallyOperator as typeof _finallyOperator & FinallyBrand;
133-
// @docs-private
134106
export const catchOperator = _catchOperator as typeof _catchOperator & CatchBrand;
135-
// @docs-private
136107
export const doOperator = _doOperator as typeof _doOperator & DoBrand;
137-
// @docs-private
138108
export const map = mapOperator as typeof mapOperator & MapBrand;
139-
// @docs-private
140109
export const filter = filterOperator as typeof filterOperator & FilterBrand;
141-
// @docs-private
142110
export const share = shareOperator as typeof shareOperator & ShareBrand;
143-
// @docs-private
144111
export const first = firstOperator as typeof firstOperator & FirstBrand;
145-
// @docs-private
146112
export const switchMap = switchMapOperator as typeof switchMapOperator & SwitchMapBrand;
147-
// @docs-private
148113
export const startWith = startWithOperator as typeof startWithOperator & StartWithBrand;
149-
// @docs-private
150114
export const debounceTime = debounceTimeOperator as typeof debounceTimeOperator & DebounceTimeBrand;
151-
// @docs-private
152115
export const auditTime = auditTimeOperator as typeof auditTimeOperator & AuditTimeBrand;
153-
// @docs-private
154116
export const takeUntil = takeUntilOperator as typeof takeUntilOperator & TakeUntilBrand;

0 commit comments

Comments
 (0)