Skip to content

Commit 47bbaca

Browse files
committed
docs: replace @note with @remarks
Updated TSDoc comments by replacing @note with @remarks across the codebase. This aligns with TSDoc's preferred conventions, where @remarks is used for supplementary explanations and additional context. (cherry picked from commit daea0ab)
1 parent b86bb08 commit 47bbaca

File tree

7 files changed

+13
-13
lines changed

7 files changed

+13
-13
lines changed

packages/angular/build/src/tools/esbuild/server-bundle-metadata-plugin.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import type { Plugin } from 'esbuild';
1515
* @param options Optional configuration object.
1616
* - `ssrEntryBundle`: If `true`, marks the bundle as an SSR entry point.
1717
*
18-
* @note We can't rely on `platform: node` or `platform: neutral`, as the latter
18+
* @remarks We can't rely on `platform: node` or `platform: neutral`, as the latter
1919
* is used for non-SSR-related code too (e.g., global scripts).
2020
* @returns An esbuild plugin that injects SSR metadata into the build result's metafile.
2121
*/

packages/angular/cli/src/analytics/analytics-parameters.mts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ export enum RequestParameter {
4141

4242
/**
4343
* User scoped custom dimensions.
44-
* @notes
44+
* @remarks
4545
* - User custom dimensions limit is 25.
4646
* - `up.*` string type.
4747
* - `upn.*` number type.
@@ -61,7 +61,7 @@ export enum UserCustomDimension {
6161

6262
/**
6363
* Event scoped custom dimensions.
64-
* @notes
64+
* @remarks
6565
* - Event custom dimensions limit is 50.
6666
* - `ep.*` string type.
6767
* - `epn.*` number type.
@@ -84,7 +84,7 @@ export enum EventCustomDimension {
8484

8585
/**
8686
* Event scoped custom mertics.
87-
* @notes
87+
* @remarks
8888
* - Event scoped custom mertics limit is 50.
8989
* - `ep.*` string type.
9090
* - `epn.*` number type.

packages/angular/cli/src/analytics/analytics-parameters.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ export enum RequestParameter {
4343

4444
/**
4545
* User scoped custom dimensions.
46-
* @notes
46+
* @remarks
4747
* - User custom dimensions limit is 25.
4848
* - `up.*` string type.
4949
* - `upn.*` number type.
@@ -63,7 +63,7 @@ export enum UserCustomDimension {
6363

6464
/**
6565
* Event scoped custom dimensions.
66-
* @notes
66+
* @remarks
6767
* - Event custom dimensions limit is 50.
6868
* - `ep.*` string type.
6969
* - `epn.*` number type.
@@ -86,7 +86,7 @@ export enum EventCustomDimension {
8686

8787
/**
8888
* Event scoped custom mertics.
89-
* @notes
89+
* @remarks
9090
* - Event scoped custom mertics limit is 50.
9191
* - `ep.*` string type.
9292
* - `epn.*` number type.

packages/angular/ssr/node/src/app-engine.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import { createWebRequestFromNodeRequest } from './request';
1515
* Manages Angular server applications (including localized ones), handles rendering requests,
1616
* and optionally transforms index HTML before rendering.
1717
*
18-
* @note This class should be instantiated once and used as a singleton across the server-side
18+
* @remarks This class should be instantiated once and used as a singleton across the server-side
1919
* application to ensure consistent handling of rendering requests and resource management.
2020
*
2121
* @developerPreview
@@ -31,7 +31,7 @@ export class AngularNodeAppEngine {
3131
* @param requestContext - Optional context for rendering, such as metadata associated with the request.
3232
* @returns A promise that resolves to the resulting HTTP response object, or `null` if no matching Angular route is found.
3333
*
34-
* @note A request to `https://www.example.com/page/index.html` will serve or render the Angular route
34+
* @remarks A request to `https://www.example.com/page/index.html` will serve or render the Angular route
3535
* corresponding to `https://www.example.com/page`.
3636
*/
3737
async handle(request: IncomingMessage, requestContext?: unknown): Promise<Response | null> {

packages/angular/ssr/src/app-engine.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import { stripIndexHtmlFromURL, stripTrailingSlash } from './utils/url';
1717
* Manages Angular server applications (including localized ones), handles rendering requests,
1818
* and optionally transforms index HTML before rendering.
1919
*
20-
* @note This class should be instantiated once and used as a singleton across the server-side
20+
* @remarks This class should be instantiated once and used as a singleton across the server-side
2121
* application to ensure consistent handling of rendering requests and resource management.
2222
*
2323
* @developerPreview
@@ -60,7 +60,7 @@ export class AngularAppEngine {
6060
* @param requestContext - Optional context for rendering, such as metadata associated with the request.
6161
* @returns A promise that resolves to the resulting HTTP response object, or `null` if no matching Angular route is found.
6262
*
63-
* @note A request to `https://www.example.com/page/index.html` will serve or render the Angular route
63+
* @remarks A request to `https://www.example.com/page/index.html` will serve or render the Angular route
6464
* corresponding to `https://www.example.com/page`.
6565
*/
6666
async handle(request: Request, requestContext?: unknown): Promise<Response | null> {

packages/angular/ssr/src/app.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ export class AngularServerApp {
114114
* @param requestContext - Optional context for rendering, such as metadata associated with the request.
115115
* @returns A promise that resolves to the resulting HTTP response object, or `null` if no matching Angular route is found.
116116
*
117-
* @note A request to `https://www.example.com/page/index.html` will serve or render the Angular route
117+
* @remarks A request to `https://www.example.com/page/index.html` will serve or render the Angular route
118118
* corresponding to `https://www.example.com/page`.
119119
*/
120120
async handle(request: Request, requestContext?: unknown): Promise<Response | null> {

packages/angular/ssr/src/manifest.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ export interface EntryPointExports {
3838
/**
3939
* A reference to the function that creates an Angular server application instance.
4040
*
41-
* @note The return type is `unknown` to prevent circular dependency issues.
41+
* @remarks The return type is `unknown` to prevent circular dependency issues.
4242
*/
4343
ɵgetOrCreateAngularServerApp: () => unknown;
4444

0 commit comments

Comments
 (0)