Skip to content

Commit 6c46599

Browse files
Florian PAULfpaul-1A
authored andcommitted
fix: jsdoc
1 parent 22dd25b commit 6c46599

File tree

68 files changed

+102
-100
lines changed

Some content is hidden

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

68 files changed

+102
-100
lines changed

packages/@ama-mcp/github/src/find-repositories-using-library/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import type {
2828
export interface GetRepositoriesUsingLibraryOptions extends CacheToolOptions, GithubToolOptions, ToolDefinition {
2929
/**
3030
* Scopes to look for when searching for repositories
31-
* (e.g. for @ama-mcp/github, the scope is ama-mcp)
31+
* (e.g. for `@ama-mcp/github`, the scope is ama-mcp)
3232
* Limit to 10 scopes to avoid hitting GitHub search API rate limit
3333
* @example ['ama-mcp', 'o3r']
3434
*/

packages/@ama-mfe/ng-utils/src/messages/available-sender.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import type {
66
} from '../managers/interfaces';
77

88
/**
9-
* Gets the available consumers and formats them into a {@see DeclareMessages} object.
9+
* Gets the available consumers and formats them into a {@link DeclareMessages} object.
1010
* @param consumers - The list of registered message consumers.
1111
* @returns The formatted DeclareMessages object.
1212
*/

packages/@ama-mfe/ng-utils/src/navigation/restore-route-pipe.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ export class RestoreRoute implements PipeTransform {
5454
/**
5555
* Transforms the given URL or SafeResourceUrl by appending query parameters and adjusting the pathname.
5656
* @param url - The URL or SafeResourceUrl to be transformed.
57-
* @param options - Optional parameters to control the transformation. {@see RestoreRouteOptions}
57+
* @param options - Optional parameters to control the transformation. {@link RestoreRouteOptions}
5858
* @returns - The transformed SafeResourceUrl or undefined if the input URL is invalid.
5959
*/
6060
public transform(url: string, options?: Partial<RestoreRouteOptions>): string;

packages/@ama-mfe/ng-utils/src/navigation/routing-service.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ export class RoutingService implements MessageProducer<NavigationMessage>, Messa
115115
* Handles embedded routing by listening to router events and sending navigation messages to the connected endpoints.
116116
* It can be a parent window or another iframe
117117
* @note - This method has to be called in an injection context
118-
* @param options - Optional parameters to control the routing behavior {@see RoutingServiceOptions}.
118+
* @param options - Optional parameters to control the routing behavior {@link RoutingServiceOptions}.
119119
*/
120120
public handleEmbeddedRouting(options?: RoutingServiceOptions): void {
121121
const subRouteOnly = options?.subRouteOnly ?? false;

packages/@ama-openapi/redocly-plugin/src/logger.mts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import type {
99
RuleSeverity,
1010
} from '@redocly/openapi-core';
1111

12-
/** Duplicate of Problem not exposed by @redocly/openapi-core */
12+
/** Duplicate of Problem not exposed by `@redocly/openapi-core` */
1313
type Problem = {
1414
message: string;
1515
suggest?: string[];

packages/@ama-sdk/client-fetch/src/plugins/perf-metric/perf-metric-fetch.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ import type {
1313

1414
/**
1515
* Performance metric mark associated to a call.
16-
* @deprecated use {@link CoreMark|Mark from @ama-sdk/core} instead. Will be removed in v15
16+
* @deprecated use {@link CoreMark|Mark from `@ama-sdk/core`} instead. Will be removed in v15
1717
*/
1818
export type Mark = CoreMark;
1919

2020
/**
2121
* Options for the Performance Metric Plugin.
22-
* @deprecated use {@link CorePerformanceMetricOptions|PerformanceMetricOptions from @ama-sdk/core} instead. Will be removed in v15
22+
* @deprecated use {@link CorePerformanceMetricOptions|PerformanceMetricOptions from `@ama-sdk/core`} instead. Will be removed in v15
2323
*/
2424
export type PerformanceMetricOptions = CorePerformanceMetricOptions;
2525

packages/@ama-sdk/client-fetch/src/plugins/timeout/timeout-fetch.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ type ImpervaCaptchaMessageData = {
2020
};
2121

2222
/**
23-
* Type to describe the timer status of the {@see TimeoutFetch} plugin.
23+
* Type to describe the timer status of the {@link TimeoutFetch} plugin.
2424
* Today, only the stop and restart of the timer is supported which match the following events:
2525
* - stop: stop the timeout timer
2626
* - start: reset the timer and restart it
@@ -44,7 +44,7 @@ function isImpervaCaptchaMessage(message: any): message is ImpervaCaptchaMessage
4444
*/
4545
export type TimeoutPauseEventHandler = ((timeoutPauseCallback: (timeoutStatus: TimeoutStatus) => void, context: any) => () => void);
4646
/**
47-
* Factory to generate a {@see TimeoutPauseEventHandler} depending on various configurations
47+
* Factory to generate a {@link TimeoutPauseEventHandler} depending on various configurations
4848
*/
4949
export type TimeoutPauseEventHandlerFactory<T> = (config?: Partial<T>) => TimeoutPauseEventHandler;
5050

packages/@ama-sdk/core/schematics/ng-add/index.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ const updateImports: Rule = (tree) => {
4444
const packageJsonPath = path.resolve(__dirname, '..', '..', 'package.json');
4545

4646
/**
47-
* Rule to import all the necessary dependency to run an @ama-sdk based application
47+
* Rule to import all the necessary dependency to run an `@ama-sdk` based application
4848
* Helps to migrate from previous versions with an import replacement
4949
* @param options schema options
5050
*/
@@ -57,7 +57,7 @@ function ngAddFn(options: NgAddSchematicsSchema): Rule {
5757
}
5858

5959
/**
60-
* Rule to import all the necessary dependency to run an @ama-sdk based application
60+
* Rule to import all the necessary dependency to run an `@ama-sdk` based application
6161
* Helps to migrate from previous versions with an import replacement
6262
* @param options
6363
*/

packages/@ama-sdk/core/src/fwk/core/api-client.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ export interface RequestOptionsParameters {
4848

4949
/**
5050
* API Client used by the SDK's APIs to call the server
51-
* The list of official clients is available in @ama-sdk/core {@link https://github.com/AmadeusITGroup/otter/tree/main/packages/%40ama-sdk/core/README.md#available-api-client|readme}
51+
* The list of official clients is available in `@ama-sdk/core` {@link https://github.com/AmadeusITGroup/otter/tree/main/packages/%40ama-sdk/core/README.md#available-api-client|readme}
5252
*/
5353
export interface ApiClient {
5454

packages/@ama-sdk/schematics/schematics/code-generator/open-api-cli-generator/open-api-cli-generator.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import {
1515
} from './open-api-cli-options';
1616

1717
/**
18-
* Manage the schematic to generate a sdk using the @openapitools/openapi-generator-cli
18+
* Manage the schematic to generate a sdk using the `@openapitools/openapi-generator-cli`
1919
*/
2020
export class OpenApiCliGenerator extends CodeGenerator<OpenApiCliOptions> {
2121
protected readonly packageManager: 'npm' | 'yarn';

0 commit comments

Comments
 (0)