Skip to content

Commit 42f203e

Browse files
mmalerbaalxhub
mmalerba
authored and
alxhub
committed
docs: rename @nodoc to @docs-private (#61196)
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 #61196
1 parent c92c34d commit 42f203e

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

+133
-177
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>;
@@ -624,9 +619,7 @@ export class NgOptimizedImage implements OnInit, OnChanges {
624619
static ngAcceptInputType_priority: unknown;
625620
// (undocumented)
626621
static ngAcceptInputType_width: unknown;
627-
// (undocumented)
628622
ngOnChanges(changes: SimpleChanges): void;
629-
// (undocumented)
630623
ngOnInit(): void;
631624
ngSrc: string;
632625
ngSrcset: string;
@@ -770,7 +763,6 @@ export class PathLocationStrategy extends LocationStrategy implements OnDestroy
770763
getState(): unknown;
771764
// (undocumented)
772765
historyGo(relativePosition?: number): void;
773-
// (undocumented)
774766
ngOnDestroy(): void;
775767
// (undocumented)
776768
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
@@ -140,9 +140,7 @@ export interface AbstractControlOptions {
140140
export class AbstractFormGroupDirective extends ControlContainer implements OnInit, OnDestroy {
141141
get control(): FormGroup;
142142
get formDirective(): Form | null;
143-
// (undocumented)
144143
ngOnDestroy(): void;
145-
// (undocumented)
146144
ngOnInit(): void;
147145
get path(): string[];
148146
// (undocumented)
@@ -222,7 +220,6 @@ export class DefaultValueAccessor extends BaseControlValueAccessor implements Co
222220
// @public
223221
export class EmailValidator extends AbstractValidatorDirective {
224222
email: boolean | string;
225-
// (undocumented)
226223
enabled(input: boolean): boolean;
227224
// (undocumented)
228225
static ɵdir: i0.ɵɵDirectiveDeclaration<EmailValidator, "[email][formControlName],[email][formControl],[email][ngModel]", never, { "email": { "alias": "email"; "required": false; }; }, {}, never, never, false, never>;
@@ -360,9 +357,7 @@ export class FormControlDirective extends NgControl implements OnChanges, OnDest
360357
set isDisabled(isDisabled: boolean);
361358
// @deprecated (undocumented)
362359
model: any;
363-
// (undocumented)
364360
ngOnChanges(changes: SimpleChanges): void;
365-
// (undocumented)
366361
ngOnDestroy(): void;
367362
get path(): string[];
368363
// @deprecated (undocumented)
@@ -384,9 +379,7 @@ export class FormControlName extends NgControl implements OnChanges, OnDestroy {
384379
// @deprecated (undocumented)
385380
model: any;
386381
name: string | number | null;
387-
// (undocumented)
388382
ngOnChanges(changes: SimpleChanges): void;
389-
// (undocumented)
390383
ngOnDestroy(): void;
391384
get path(): string[];
392385
// @deprecated (undocumented)
@@ -491,9 +484,7 @@ export class FormGroupDirective extends ControlContainer implements Form, OnChan
491484
getControl(dir: FormControlName): FormControl;
492485
getFormArray(dir: FormArrayName): FormArray;
493486
getFormGroup(dir: FormGroupName): FormGroup;
494-
// (undocumented)
495487
ngOnChanges(changes: SimpleChanges): void;
496-
// (undocumented)
497488
ngOnDestroy(): void;
498489
ngSubmit: EventEmitter<any>;
499490
onReset(): void;
@@ -685,7 +676,6 @@ export class NgForm extends ControlContainer implements Form, AfterViewInit {
685676
get formDirective(): Form;
686677
getControl(dir: NgModel): FormControl;
687678
getFormGroup(dir: NgModelGroup): FormGroup;
688-
// (undocumented)
689679
ngAfterViewInit(): void;
690680
ngSubmit: EventEmitter<any>;
691681
onReset(): void;
@@ -717,11 +707,8 @@ export class NgModel extends NgControl implements OnChanges, OnDestroy {
717707
isDisabled: boolean;
718708
model: any;
719709
name: string;
720-
// (undocumented)
721710
static ngAcceptInputType_isDisabled: boolean | string;
722-
// (undocumented)
723711
ngOnChanges(changes: SimpleChanges): void;
724-
// (undocumented)
725712
ngOnDestroy(): void;
726713
options: {
727714
name?: string;
@@ -752,7 +739,6 @@ export class NgModelGroup extends AbstractFormGroupDirective implements OnInit,
752739
export class NgSelectOption implements OnDestroy {
753740
constructor(_element: ElementRef, _renderer: Renderer2, _select: SelectControlValueAccessor);
754741
id: string;
755-
// (undocumented)
756742
ngOnDestroy(): void;
757743
set ngValue(value: any);
758744
set value(value: any);
@@ -810,13 +796,10 @@ export class RadioControlValueAccessor extends BuiltInControlValueAccessor imple
810796
fireUncheck(value: any): void;
811797
formControlName: string;
812798
name: string;
813-
// (undocumented)
814799
ngOnDestroy(): void;
815-
// (undocumented)
816800
ngOnInit(): void;
817801
onChange: () => void;
818802
registerOnChange(fn: (_: any) => {}): void;
819-
// (undocumented)
820803
setDisabledState(isDisabled: boolean): void;
821804
value: any;
822805
writeValue(value: any): void;
@@ -852,7 +835,6 @@ export class ReactiveFormsModule {
852835

853836
// @public
854837
export class RequiredValidator extends AbstractValidatorDirective {
855-
// (undocumented)
856838
enabled(input: boolean): boolean;
857839
required: boolean | string;
858840
// (undocumented)
@@ -865,7 +847,6 @@ export class RequiredValidator extends AbstractValidatorDirective {
865847
export class SelectControlValueAccessor extends BuiltInControlValueAccessor implements ControlValueAccessor {
866848
set compareWith(fn: (o1: any, o2: any) => boolean);
867849
registerOnChange(fn: (value: any) => any): void;
868-
// (undocumented)
869850
value: any;
870851
writeValue(value: any): void;
871852
// (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
@@ -716,7 +716,6 @@ export class Router {
716716
navigate(commands: any[], extras?: NavigationExtras): Promise<boolean>;
717717
navigateByUrl(url: string | UrlTree, extras?: NavigationBehaviorOptions): Promise<boolean>;
718718
navigated: boolean;
719-
// (undocumented)
720719
ngOnDestroy(): void;
721720
// @deprecated
722721
onSameUrlNavigation: OnSameUrlNavigation;
@@ -804,11 +803,8 @@ class RouterLink implements OnChanges, OnDestroy {
804803
static ngAcceptInputType_replaceUrl: unknown;
805804
// (undocumented)
806805
static ngAcceptInputType_skipLocationChange: unknown;
807-
// (undocumented)
808806
ngOnChanges(changes?: SimpleChanges): void;
809-
// (undocumented)
810807
ngOnDestroy(): any;
811-
// (undocumented)
812808
onClick(button: number, ctrlKey: boolean, shiftKey: boolean, altKey: boolean, metaKey: boolean): boolean;
813809
preserveFragment: boolean;
814810
queryParams?: Params | null;
@@ -840,11 +836,8 @@ export class RouterLinkActive implements OnChanges, OnDestroy, AfterContentInit
840836
readonly isActiveChange: EventEmitter<boolean>;
841837
// (undocumented)
842838
links: QueryList<RouterLink>;
843-
// (undocumented)
844839
ngAfterContentInit(): void;
845-
// (undocumented)
846840
ngOnChanges(changes: SimpleChanges): void;
847-
// (undocumented)
848841
ngOnDestroy(): void;
849842
// (undocumented)
850843
set routerLinkActive(data: string[] | string);
@@ -893,14 +886,10 @@ export class RouterOutlet implements OnDestroy, OnInit, RouterOutletContract {
893886
// (undocumented)
894887
get isActivated(): boolean;
895888
name: string;
896-
// (undocumented)
897889
ngOnChanges(changes: SimpleChanges): void;
898-
// (undocumented)
899890
ngOnDestroy(): void;
900-
// (undocumented)
901891
ngOnInit(): void;
902892
readonly routerOutletData: i0.InputSignal<unknown>;
903-
// (undocumented)
904893
readonly supportsBindingToComponentInputs = true;
905894
// (undocumented)
906895
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>;
@@ -928,7 +917,6 @@ export interface RouterOutletContract {
928917
// @public
929918
export class RouterPreloader implements OnDestroy {
930919
constructor(router: Router, injector: EnvironmentInjector, preloadingStrategy: PreloadingStrategy, loader: RouterConfigLoader);
931-
// (undocumented)
932920
ngOnDestroy(): void;
933921
// (undocumented)
934922
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';
@@ -240,7 +240,7 @@ export class NgForOf<T, U extends NgIterable<T> = NgIterable<T>> implements DoCh
240240

241241
/**
242242
* Applies the changes when needed.
243-
* @nodoc
243+
* @docs-private
244244
*/
245245
ngDoCheck(): void {
246246
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';
@@ -412,7 +412,7 @@ export class NgOptimizedImage implements OnInit, OnChanges {
412412
}
413413
}
414414

415-
/** @nodoc */
415+
/** @docs-private */
416416
ngOnInit() {
417417
performanceMarkFeature('NgOptimizedImage');
418418

@@ -524,7 +524,7 @@ export class NgOptimizedImage implements OnInit, OnChanges {
524524
}
525525
}
526526

527-
/** @nodoc */
527+
/** @docs-private */
528528
ngOnChanges(changes: SimpleChanges) {
529529
if (ngDevMode) {
530530
assertNoPostInitInputChange(this, changes, [

0 commit comments

Comments
 (0)