Skip to content

Commit c0e9fc1

Browse files
mmalerbaalxhub
mmalerba
authored and
alxhub
committed
docs: rename @nodoc to @docs-private (#61194)
This aligns with how angular/components marks their hidden APIs. `@nodoc` has been broken since the switch to adev, this change should properly hide the APIs again. PR Close #61194
1 parent 12a5b7b commit c0e9fc1

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+139
-184
lines changed

‎goldens/public-api/common/index.api.md‎

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,6 @@ export class HashLocationStrategy extends LocationStrategy implements OnDestroy
270270
getState(): unknown;
271271
// (undocumented)
272272
historyGo(relativePosition?: number): void;
273-
// (undocumented)
274273
ngOnDestroy(): void;
275274
// (undocumented)
276275
onPopState(fn: LocationChangeListener): void;
@@ -396,7 +395,6 @@ class Location_2 implements OnDestroy {
396395
historyGo(relativePosition?: number): void;
397396
isCurrentPathEqualTo(path: string, query?: string): boolean;
398397
static joinWithSlash: (start: string, end: string) => string;
399-
// (undocumented)
400398
ngOnDestroy(): void;
401399
normalize(url: string): string;
402400
static normalizeQueryParams: (params: string) => string;
@@ -504,11 +502,8 @@ export class NgComponentOutlet<T = any> implements OnChanges, DoCheck, OnDestroy
504502
ngComponentOutletNgModule?: Type<any>;
505503
// @deprecated (undocumented)
506504
ngComponentOutletNgModuleFactory?: NgModuleFactory<any>;
507-
// (undocumented)
508505
ngDoCheck(): void;
509-
// (undocumented)
510506
ngOnChanges(changes: SimpleChanges): void;
511-
// (undocumented)
512507
ngOnDestroy(): void;
513508
// (undocumented)
514509
static ɵdir: i0.ɵɵDirectiveDeclaration<NgComponentOutlet<any>, "[ngComponentOutlet]", ["ngComponentOutlet"], { "ngComponentOutlet": { "alias": "ngComponentOutlet"; "required": false; }; "ngComponentOutletInputs": { "alias": "ngComponentOutletInputs"; "required": false; }; "ngComponentOutletInjector": { "alias": "ngComponentOutletInjector"; "required": false; }; "ngComponentOutletContent": { "alias": "ngComponentOutletContent"; "required": false; }; "ngComponentOutletNgModule": { "alias": "ngComponentOutletNgModule"; "required": false; }; "ngComponentOutletNgModuleFactory": { "alias": "ngComponentOutletNgModuleFactory"; "required": false; }; }, {}, never, never, true, never>;
@@ -630,9 +625,7 @@ export class NgOptimizedImage implements OnInit, OnChanges {
630625
static ngAcceptInputType_priority: unknown;
631626
// (undocumented)
632627
static ngAcceptInputType_width: unknown;
633-
// (undocumented)
634628
ngOnChanges(changes: SimpleChanges): void;
635-
// (undocumented)
636629
ngOnInit(): void;
637630
ngSrc: string;
638631
ngSrcset: string;
@@ -778,7 +771,6 @@ export class PathLocationStrategy extends LocationStrategy implements OnDestroy
778771
getState(): unknown;
779772
// (undocumented)
780773
historyGo(relativePosition?: number): void;
781-
// (undocumented)
782774
ngOnDestroy(): void;
783775
// (undocumented)
784776
onPopState(fn: LocationChangeListener): void;

‎goldens/public-api/common/testing/index.api.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,6 @@ export class SpyLocation implements Location_2 {
121121
historyGo(relativePosition?: number): void;
122122
// (undocumented)
123123
isCurrentPathEqualTo(path: string, query?: string): boolean;
124-
// (undocumented)
125124
ngOnDestroy(): void;
126125
// (undocumented)
127126
normalize(url: string): string;

‎goldens/public-api/forms/index.api.md‎

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -143,9 +143,7 @@ export interface AbstractControlOptions {
143143
export class AbstractFormGroupDirective extends ControlContainer implements OnInit, OnDestroy {
144144
get control(): FormGroup;
145145
get formDirective(): Form | null;
146-
// (undocumented)
147146
ngOnDestroy(): void;
148-
// (undocumented)
149147
ngOnInit(): void;
150148
get path(): string[];
151149
// (undocumented)
@@ -225,7 +223,6 @@ export class DefaultValueAccessor extends BaseControlValueAccessor implements Co
225223
// @public
226224
export class EmailValidator extends AbstractValidatorDirective {
227225
email: boolean | string;
228-
// (undocumented)
229226
enabled(input: boolean): boolean;
230227
// (undocumented)
231228
static ɵdir: i0.ɵɵDirectiveDeclaration<EmailValidator, "[email][formControlName],[email][formControl],[email][ngModel]", never, { "email": { "alias": "email"; "required": false; }; }, {}, never, never, false, never>;
@@ -363,9 +360,7 @@ export class FormControlDirective extends NgControl implements OnChanges, OnDest
363360
set isDisabled(isDisabled: boolean);
364361
// @deprecated (undocumented)
365362
model: any;
366-
// (undocumented)
367363
ngOnChanges(changes: SimpleChanges): void;
368-
// (undocumented)
369364
ngOnDestroy(): void;
370365
get path(): string[];
371366
// @deprecated (undocumented)
@@ -387,9 +382,7 @@ export class FormControlName extends NgControl implements OnChanges, OnDestroy {
387382
// @deprecated (undocumented)
388383
model: any;
389384
name: string | number | null;
390-
// (undocumented)
391385
ngOnChanges(changes: SimpleChanges): void;
392-
// (undocumented)
393386
ngOnDestroy(): void;
394387
get path(): string[];
395388
// @deprecated (undocumented)
@@ -494,9 +487,7 @@ export class FormGroupDirective extends ControlContainer implements Form, OnChan
494487
getControl(dir: FormControlName): FormControl;
495488
getFormArray(dir: FormArrayName): FormArray;
496489
getFormGroup(dir: FormGroupName): FormGroup;
497-
// (undocumented)
498490
ngOnChanges(changes: SimpleChanges): void;
499-
// (undocumented)
500491
ngOnDestroy(): void;
501492
ngSubmit: EventEmitter<any>;
502493
onReset(): void;
@@ -691,7 +682,6 @@ export class NgForm extends ControlContainer implements Form, AfterViewInit {
691682
get formDirective(): Form;
692683
getControl(dir: NgModel): FormControl;
693684
getFormGroup(dir: NgModelGroup): FormGroup;
694-
// (undocumented)
695685
ngAfterViewInit(): void;
696686
ngSubmit: EventEmitter<any>;
697687
onReset(): void;
@@ -723,11 +713,8 @@ export class NgModel extends NgControl implements OnChanges, OnDestroy {
723713
isDisabled: boolean;
724714
model: any;
725715
name: string;
726-
// (undocumented)
727716
static ngAcceptInputType_isDisabled: boolean | string;
728-
// (undocumented)
729717
ngOnChanges(changes: SimpleChanges): void;
730-
// (undocumented)
731718
ngOnDestroy(): void;
732719
options: {
733720
name?: string;
@@ -758,7 +745,6 @@ export class NgModelGroup extends AbstractFormGroupDirective implements OnInit,
758745
export class NgSelectOption implements OnDestroy {
759746
constructor(_element: ElementRef, _renderer: Renderer2, _select: SelectControlValueAccessor);
760747
id: string;
761-
// (undocumented)
762748
ngOnDestroy(): void;
763749
set ngValue(value: any);
764750
set value(value: any);
@@ -816,13 +802,10 @@ export class RadioControlValueAccessor extends BuiltInControlValueAccessor imple
816802
fireUncheck(value: any): void;
817803
formControlName: string;
818804
name: string;
819-
// (undocumented)
820805
ngOnDestroy(): void;
821-
// (undocumented)
822806
ngOnInit(): void;
823807
onChange: () => void;
824808
registerOnChange(fn: (_: any) => {}): void;
825-
// (undocumented)
826809
setDisabledState(isDisabled: boolean): void;
827810
value: any;
828811
writeValue(value: any): void;
@@ -858,7 +841,6 @@ export class ReactiveFormsModule {
858841

859842
// @public
860843
export class RequiredValidator extends AbstractValidatorDirective {
861-
// (undocumented)
862844
enabled(input: boolean): boolean;
863845
required: boolean | string;
864846
// (undocumented)
@@ -871,7 +853,6 @@ export class RequiredValidator extends AbstractValidatorDirective {
871853
export class SelectControlValueAccessor extends BuiltInControlValueAccessor implements ControlValueAccessor {
872854
set compareWith(fn: (o1: any, o2: any) => boolean);
873855
registerOnChange(fn: (value: any) => any): void;
874-
// (undocumented)
875856
value: any;
876857
writeValue(value: any): void;
877858
// (undocumented)

‎goldens/public-api/localize/index.api.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ export type TargetMessage = string;
1919
// @public
2020
export const ɵ$localize: ɵLocalizeFn;
2121

22-
// @public (undocumented)
22+
// @public
2323
export interface ɵLocalizeFn {
2424
// (undocumented)
2525
(messageParts: TemplateStringsArray, ...expressions: readonly any[]): string;
2626
locale?: string;
2727
translate?: ɵTranslateFn;
2828
}
2929

30-
// @public (undocumented)
30+
// @public
3131
export interface ɵTranslateFn {
3232
// (undocumented)
3333
(messageParts: TemplateStringsArray, expressions: readonly any[]): [TemplateStringsArray, readonly any[]];

‎goldens/public-api/localize/init/index.api.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@
88
const $localize_2: LocalizeFn;
99
export { $localize_2 as $localize }
1010

11-
// @public (undocumented)
11+
// @public
1212
export interface LocalizeFn {
1313
// (undocumented)
1414
(messageParts: TemplateStringsArray, ...expressions: readonly any[]): string;
1515
locale?: string;
1616
translate?: TranslateFn;
1717
}
1818

19-
// @public (undocumented)
19+
// @public
2020
export interface TranslateFn {
2121
// (undocumented)
2222
(messageParts: TemplateStringsArray, expressions: readonly any[]): [TemplateStringsArray, readonly any[]];

‎goldens/public-api/router/index.api.md‎

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -721,7 +721,6 @@ export class Router {
721721
navigate(commands: readonly any[], extras?: NavigationExtras): Promise<boolean>;
722722
navigateByUrl(url: string | UrlTree, extras?: NavigationBehaviorOptions): Promise<boolean>;
723723
navigated: boolean;
724-
// (undocumented)
725724
ngOnDestroy(): void;
726725
// @deprecated
727726
onSameUrlNavigation: OnSameUrlNavigation;
@@ -810,11 +809,8 @@ class RouterLink implements OnChanges, OnDestroy {
810809
static ngAcceptInputType_replaceUrl: unknown;
811810
// (undocumented)
812811
static ngAcceptInputType_skipLocationChange: unknown;
813-
// (undocumented)
814812
ngOnChanges(changes?: SimpleChanges): void;
815-
// (undocumented)
816813
ngOnDestroy(): any;
817-
// (undocumented)
818814
onClick(button: number, ctrlKey: boolean, shiftKey: boolean, altKey: boolean, metaKey: boolean): boolean;
819815
preserveFragment: boolean;
820816
queryParams?: Params | null;
@@ -848,11 +844,8 @@ export class RouterLinkActive implements OnChanges, OnDestroy, AfterContentInit
848844
readonly isActiveChange: EventEmitter<boolean>;
849845
// (undocumented)
850846
links: QueryList<RouterLink>;
851-
// (undocumented)
852847
ngAfterContentInit(): void;
853-
// (undocumented)
854848
ngOnChanges(changes: SimpleChanges): void;
855-
// (undocumented)
856849
ngOnDestroy(): void;
857850
// (undocumented)
858851
set routerLinkActive(data: string[] | string);
@@ -901,14 +894,10 @@ export class RouterOutlet implements OnDestroy, OnInit, RouterOutletContract {
901894
// (undocumented)
902895
get isActivated(): boolean;
903896
name: string;
904-
// (undocumented)
905897
ngOnChanges(changes: SimpleChanges): void;
906-
// (undocumented)
907898
ngOnDestroy(): void;
908-
// (undocumented)
909899
ngOnInit(): void;
910900
readonly routerOutletData: i0.InputSignal<unknown>;
911-
// (undocumented)
912901
readonly supportsBindingToComponentInputs = true;
913902
// (undocumented)
914903
static ɵdir: i0.ɵɵDirectiveDeclaration<RouterOutlet, "router-outlet", ["outlet"], { "name": { "alias": "name"; "required": false; }; "routerOutletData": { "alias": "routerOutletData"; "required": false; "isSignal": true; }; }, { "activateEvents": "activate"; "deactivateEvents": "deactivate"; "attachEvents": "attach"; "detachEvents": "detach"; }, never, never, true, never>;
@@ -936,7 +925,6 @@ export interface RouterOutletContract {
936925
// @public
937926
export class RouterPreloader implements OnDestroy {
938927
constructor(router: Router, injector: EnvironmentInjector, preloadingStrategy: PreloadingStrategy, loader: RouterConfigLoader);
939-
// (undocumented)
940928
ngOnDestroy(): void;
941929
// (undocumented)
942930
preload(): Observable<any>;

‎goldens/public-api/upgrade/static/index.api.md‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,13 +54,9 @@ export function setAngularLib(ng: any): void;
5454
// @public
5555
export class UpgradeComponent implements OnInit, OnChanges, DoCheck, OnDestroy {
5656
constructor(name: string, elementRef: ElementRef, injector: Injector);
57-
// (undocumented)
5857
ngDoCheck(): void;
59-
// (undocumented)
6058
ngOnChanges(changes: SimpleChanges): void;
61-
// (undocumented)
6259
ngOnDestroy(): void;
63-
// (undocumented)
6460
ngOnInit(): void;
6561
// (undocumented)
6662
static ɵdir: i0.ɵɵDirectiveDeclaration<UpgradeComponent, never, never, {}, {}, never, never, true, never>;

‎packages/common/src/directives/ng_component_outlet.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ export class NgComponentOutlet<T = any> implements OnChanges, DoCheck, OnDestroy
153153
);
154154
}
155155

156-
/** @nodoc */
156+
/** @docs-private */
157157
ngOnChanges(changes: SimpleChanges) {
158158
if (this._needToReCreateComponentInstance(changes)) {
159159
this._viewContainerRef.clear();
@@ -189,7 +189,7 @@ export class NgComponentOutlet<T = any> implements OnChanges, DoCheck, OnDestroy
189189
}
190190
}
191191

192-
/** @nodoc */
192+
/** @docs-private */
193193
ngDoCheck() {
194194
if (this._componentRef) {
195195
if (this.ngComponentOutletInputs) {
@@ -202,7 +202,7 @@ export class NgComponentOutlet<T = any> implements OnChanges, DoCheck, OnDestroy
202202
}
203203
}
204204

205-
/** @nodoc */
205+
/** @docs-private */
206206
ngOnDestroy() {
207207
this._moduleRef?.destroy();
208208
}

‎packages/common/src/directives/ng_for_of.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ import {
1616
IterableDiffer,
1717
IterableDiffers,
1818
NgIterable,
19+
ɵRuntimeError as RuntimeError,
1920
TemplateRef,
2021
TrackByFunction,
2122
ViewContainerRef,
22-
ɵRuntimeError as RuntimeError,
2323
} from '@angular/core';
2424

2525
import {RuntimeErrorCode} from '../errors';
@@ -249,7 +249,7 @@ export class NgForOf<T, U extends NgIterable<T> = NgIterable<T>> implements DoCh
249249

250250
/**
251251
* Applies the changes when needed.
252-
* @nodoc
252+
* @docs-private
253253
*/
254254
ngDoCheck(): void {
255255
if (this._ngForOfDirty) {

‎packages/common/src/directives/ng_optimized_image/ng_optimized_image.ts‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,29 +7,29 @@
77
*/
88

99
import {
10+
ApplicationRef,
1011
booleanAttribute,
12+
ChangeDetectorRef,
13+
DestroyRef,
1114
Directive,
1215
ElementRef,
16+
ɵformatRuntimeError as formatRuntimeError,
17+
ɵIMAGE_CONFIG as IMAGE_CONFIG,
18+
ɵIMAGE_CONFIG_DEFAULTS as IMAGE_CONFIG_DEFAULTS,
19+
ɵImageConfig as ImageConfig,
1320
inject,
1421
Injector,
1522
Input,
1623
NgZone,
1724
numberAttribute,
1825
OnChanges,
1926
OnInit,
20-
Renderer2,
21-
SimpleChanges,
22-
ɵformatRuntimeError as formatRuntimeError,
23-
ɵIMAGE_CONFIG as IMAGE_CONFIG,
24-
ɵIMAGE_CONFIG_DEFAULTS as IMAGE_CONFIG_DEFAULTS,
25-
ɵImageConfig as ImageConfig,
2627
ɵperformanceMarkFeature as performanceMarkFeature,
28+
Renderer2,
2729
ɵRuntimeError as RuntimeError,
2830
ɵSafeValue as SafeValue,
31+
SimpleChanges,
2932
ɵunwrapSafeValue as unwrapSafeValue,
30-
ChangeDetectorRef,
31-
ApplicationRef,
32-
DestroyRef,
3333
} from '@angular/core';
3434

3535
import {RuntimeErrorCode} from '../../errors';
@@ -408,7 +408,7 @@ export class NgOptimizedImage implements OnInit, OnChanges {
408408
}
409409
}
410410

411-
/** @nodoc */
411+
/** @docs-private */
412412
ngOnInit() {
413413
performanceMarkFeature('NgOptimizedImage');
414414

@@ -520,7 +520,7 @@ export class NgOptimizedImage implements OnInit, OnChanges {
520520
}
521521
}
522522

523-
/** @nodoc */
523+
/** @docs-private */
524524
ngOnChanges(changes: SimpleChanges) {
525525
if (ngDevMode) {
526526
assertNoPostInitInputChange(this, changes, [

0 commit comments

Comments
 (0)