Visitar URL original
docs: fix API links that point at missing member anchors · angular/angular@f825c9b · GitHub
Skip to content

Commit f825c9b

Browse files
erkamyamanpkozlowski-opensource
erkamyaman
authored and
pkozlowski-opensource
committed
docs: fix API links that point at missing member anchors
`{@link Symbol#member}` is turned into `/api/<module>/<Symbol>#<member>` without validation, so a miscased or stale fragment still renders a link, it just never scrolls anywhere. - `SetDisabledStateOption` linked to `FormsModule#withconfig`, the member is `withConfig`. - `downgradeModule` linked to `PlatformRef#bootstrapmodule` and `#bootstrapmodulefactory`, the members are `bootstrapModule` and `bootstrapModuleFactory`. - `NavigationExtras` linked to `Router#createurltree`, the member is `createUrlTree`. - `UpgradeModule` linked to `#upgrading-an-angular-1-service`, the heading id is `upgrading-an-angularjs-service`.
1 parent 15bfc1a commit f825c9b

4 files changed

Lines changed: 11 additions & 13 deletions

File tree

‎packages/forms/src/directives/shared.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ export const ɵFORM_CONTROL_INTEGRATION = new InjectionToken<ɵFormControlIntegr
4343
* Token to provide to allow SetDisabledState to always be called when a CVA is added, regardless of
4444
* whether the control is disabled or enabled.
4545
*
46-
* @see {@link FormsModule#withconfig}
46+
* @see {@link FormsModule#withConfig}
4747
*/
4848
export const CALL_SET_DISABLED_STATE = new InjectionToken(
4949
typeof ngDevMode === 'undefined' || ngDevMode ? 'CallSetDisabledState' : '',
@@ -58,7 +58,7 @@ export const CALL_SET_DISABLED_STATE = new InjectionToken(
5858
* called when disabled, which is the legacy behavior for compatibility.
5959
*
6060
* @publicApi
61-
* @see {@link FormsModule#withconfig}
61+
* @see {@link FormsModule#withConfig}
6262
*/
6363
export type SetDisabledStateOption = 'whenDisabledForLegacyCode' | 'always';
6464

‎packages/router/src/navigation_transition.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ export interface UrlCreationOptions {
203203
*
204204
* @see {@link Router#navigate}
205205
* @see {@link Router#navigateByUrl}
206-
* @see {@link Router#createurltree}
206+
* @see {@link Router#createUrlTree}
207207
* @see [Routing and Navigation guide](guide/routing/common-router-tasks)
208208
* @see {@link UrlCreationOptions}
209209
* @see {@link NavigationBehaviorOptions}

‎packages/upgrade/static/src/downgrade_module.ts‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -125,8 +125,8 @@ let moduleUid = 0;
125125
* `StaticProvider`s, when creating the `PlatformRef` (e.g. via `platformBrowser` or
126126
* `platformBrowserDynamic`).
127127
*
128-
* - When using {@link PlatformRef#bootstrapmodule `bootstrapModule()`} or
129-
* {@link PlatformRef#bootstrapmodulefactory `bootstrapModuleFactory()`} to bootstrap the
128+
* - When using {@link PlatformRef#bootstrapModule `bootstrapModule()`} or
129+
* {@link PlatformRef#bootstrapModuleFactory `bootstrapModuleFactory()`} to bootstrap the
130130
* downgraded modules, each one is considered a "root" module. As a consequence, a new instance
131131
* will be created for every injectable provided in `"root"` (via
132132
* {@link /api/core/Injectable#providedIn providedIn}
@@ -241,8 +241,8 @@ export function downgradeModule<T>(
241241
* `StaticProvider`s, when creating the `PlatformRef` (e.g. via `platformBrowser` or
242242
* `platformBrowserDynamic`).
243243
*
244-
* - When using {@link PlatformRef#bootstrapmodule `bootstrapModule()`} or
245-
* {@link PlatformRef#bootstrapmodulefactory `bootstrapModuleFactory()`} to bootstrap the
244+
* - When using {@link PlatformRef#bootstrapModule `bootstrapModule()`} or
245+
* {@link PlatformRef#bootstrapModuleFactory `bootstrapModuleFactory()`} to bootstrap the
246246
* downgraded modules, each one is considered a "root" module. As a consequence, a new instance
247247
* will be created for every injectable provided in `"root"` (via
248248
* {@link /api/core/Injectable#providedIn providedIn}
@@ -358,8 +358,8 @@ export function downgradeModule<T>(moduleOrBootstrapFn: NgModuleFactory<T>): str
358358
* `StaticProvider`s, when creating the `PlatformRef` (e.g. via `platformBrowser` or
359359
* `platformBrowserDynamic`).
360360
*
361-
* - When using {@link PlatformRef#bootstrapmodule `bootstrapModule()`} or
362-
* {@link PlatformRef#bootstrapmodulefactory `bootstrapModuleFactory()`} to bootstrap the
361+
* - When using {@link PlatformRef#bootstrapModule `bootstrapModule()`} or
362+
* {@link PlatformRef#bootstrapModuleFactory `bootstrapModuleFactory()`} to bootstrap the
363363
* downgraded modules, each one is considered a "root" module. As a consequence, a new instance
364364
* will be created for every injectable provided in `"root"` (via
365365
* {@link /api/core/Injectable#providedIn providedIn}
@@ -372,9 +372,7 @@ export function downgradeModule<T>(moduleOrBootstrapFn: NgModuleFactory<T>): str
372372
*/
373373
export function downgradeModule<T>(
374374
moduleOrBootstrapFn:
375-
| Type<T>
376-
| NgModuleFactory<T>
377-
| ((extraProviders: StaticProvider[]) => Promise<NgModuleRef<T>>),
375+
Type<T> | NgModuleFactory<T> | ((extraProviders: StaticProvider[]) => Promise<NgModuleRef<T>>),
378376
): string {
379377
const lazyModuleName = `${ɵconstants.UPGRADE_MODULE_NAME}.lazy${++moduleUid}`;
380378
const lazyModuleRefKey = `${ɵconstants.LAZY_MODULE_REF}${lazyModuleName}`;

‎packages/upgrade/static/src/upgrade_module.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ import {NgAdapterInjector} from './util';
4242
* that it can be used in an AngularJS template. See `downgradeComponent`.
4343
* 3. Creation of an Angular root injector provider that wraps and exposes an AngularJS
4444
* service so that it can be injected into an Angular context. See
45-
* {@link UpgradeModule#upgrading-an-angular-1-service Upgrading an AngularJS service} below.
45+
* {@link UpgradeModule#upgrading-an-angularjs-service Upgrading an AngularJS service} below.
4646
* 4. Creation of an AngularJS service that wraps and exposes an Angular injectable
4747
* so that it can be injected into an AngularJS context. See `downgradeInjectable`.
4848
* 5. Bootstrapping of a hybrid Angular application which contains both of the frameworks

0 commit comments

Comments
 (0)