diff --git a/docs/features/software-catalog/external-integrations.md b/docs/features/software-catalog/external-integrations.md index da4eb3d229..5fc2537712 100644 --- a/docs/features/software-catalog/external-integrations.md +++ b/docs/features/software-catalog/external-integrations.md @@ -89,23 +89,23 @@ export class FrobsProvider implements EntityProvider { private readonly reader: UrlReader; private connection?: EntityProviderConnection; - /** [1] **/ + /** [1] */ constructor(env: string, reader: UrlReader) { this.env = env; this.reader = reader; } - /** [2] **/ + /** [2] */ getProviderName(): string { return `frobs-${this.env}`; } - /** [3] **/ + /** [3] */ async connect(connection: EntityProviderConnection): Promise { this.connection = connection; } - /** [4] **/ + /** [4] */ async run(): Promise { if (!this.connection) { throw new Error('Not initialized'); @@ -116,10 +116,10 @@ export class FrobsProvider implements EntityProvider { ); const data = JSON.parse(await response.buffer()).toString(); - /** [5] **/ + /** [5] */ const entities: Entity[] = frobsToEntities(data); - /** [6] **/ + /** [6] */ await this.connection.applyMutation({ type: 'full', entities: entities.map(entity => ({ diff --git a/packages/backend-app-api/src/services/implementations/lifecycle/lifecycleFactory.ts b/packages/backend-app-api/src/services/implementations/lifecycle/lifecycleFactory.ts index b2f3a9f70b..299022079b 100644 --- a/packages/backend-app-api/src/services/implementations/lifecycle/lifecycleFactory.ts +++ b/packages/backend-app-api/src/services/implementations/lifecycle/lifecycleFactory.ts @@ -21,7 +21,8 @@ import { /** * Allows plugins to register shutdown hooks that are run when the process is about to exit. - * @public */ + * @public + */ export const lifecycleFactory = createServiceFactory({ service: coreServices.lifecycle, deps: { diff --git a/packages/backend-app-api/src/services/implementations/rootLifecycle/rootLifecycleFactory.ts b/packages/backend-app-api/src/services/implementations/rootLifecycle/rootLifecycleFactory.ts index f451c38f20..71ab76ae92 100644 --- a/packages/backend-app-api/src/services/implementations/rootLifecycle/rootLifecycleFactory.ts +++ b/packages/backend-app-api/src/services/implementations/rootLifecycle/rootLifecycleFactory.ts @@ -58,7 +58,9 @@ export class BackendLifecycleImpl implements RootLifecycleService { /** * Allows plugins to register shutdown hooks that are run when the process is about to exit. - * @public */ + * + * @public + */ export const rootLifecycleFactory = createServiceFactory({ service: coreServices.rootLifecycle, deps: { diff --git a/packages/backend-plugin-api/src/services/definitions/LifecycleService.ts b/packages/backend-plugin-api/src/services/definitions/LifecycleService.ts index 25cc47270e..59d14aa61d 100644 --- a/packages/backend-plugin-api/src/services/definitions/LifecycleService.ts +++ b/packages/backend-plugin-api/src/services/definitions/LifecycleService.ts @@ -18,7 +18,7 @@ import { LoggerService } from './LoggerService'; /** * @public - **/ + */ export type LifecycleServiceShutdownHook = { fn: () => void | Promise; @@ -30,7 +30,7 @@ export type LifecycleServiceShutdownHook = { /** * @public - **/ + */ export interface LifecycleService { /** * Register a function to be called when the backend is shutting down. diff --git a/packages/core-components/src/layout/Sidebar/config.ts b/packages/core-components/src/layout/Sidebar/config.ts index dacf4bd0a5..e3d126a86f 100644 --- a/packages/core-components/src/layout/Sidebar/config.ts +++ b/packages/core-components/src/layout/Sidebar/config.ts @@ -32,7 +32,7 @@ export type SubmenuOptions = { drawerWidthOpen?: number; }; -/** @internal **/ +/** @internal */ export type SidebarConfig = { drawerWidthClosed: number; drawerWidthOpen: number; @@ -78,7 +78,7 @@ export const makeSidebarConfig = ( sidebarConfig.drawerWidthClosed - sidebarConfig.userBadgePadding * 2, }); -/** @internal **/ +/** @internal */ export type SubmenuConfig = { drawerWidthClosed: number; drawerWidthOpen: number; diff --git a/packages/test-utils/src/testUtils/TestApiProvider.tsx b/packages/test-utils/src/testUtils/TestApiProvider.tsx index 51edf77cba..35fa302415 100644 --- a/packages/test-utils/src/testUtils/TestApiProvider.tsx +++ b/packages/test-utils/src/testUtils/TestApiProvider.tsx @@ -119,7 +119,7 @@ export class TestApiRegistry implements ApiHolder { * implements a subset of the `IdentityApi`. * * @public - **/ + */ export const TestApiProvider = ( props: TestApiProviderProps, ) => { diff --git a/plugins/catalog-backend-module-azure/src/processors/AzureDevOpsDiscoveryProcessor.ts b/plugins/catalog-backend-module-azure/src/processors/AzureDevOpsDiscoveryProcessor.ts index 4852edbb03..8893d5d42d 100644 --- a/plugins/catalog-backend-module-azure/src/processors/AzureDevOpsDiscoveryProcessor.ts +++ b/plugins/catalog-backend-module-azure/src/processors/AzureDevOpsDiscoveryProcessor.ts @@ -43,7 +43,7 @@ import { codeSearch } from '../lib'; * target: https://dev.azure.com/org/project/_git/repo * * @public - **/ + */ export class AzureDevOpsDiscoveryProcessor implements CatalogProcessor { private readonly integrations: ScmIntegrationRegistry; private readonly logger: Logger; @@ -123,7 +123,7 @@ export class AzureDevOpsDiscoveryProcessor implements CatalogProcessor { /** * parseUrl extracts segments from the Azure DevOps URL. - **/ + */ export function parseUrl(urlString: string): { baseUrl: string; org: string; diff --git a/plugins/catalog-backend-module-github/src/processors/GithubDiscoveryProcessor.ts b/plugins/catalog-backend-module-github/src/processors/GithubDiscoveryProcessor.ts index 3fec87d0b2..c6733df13b 100644 --- a/plugins/catalog-backend-module-github/src/processors/GithubDiscoveryProcessor.ts +++ b/plugins/catalog-backend-module-github/src/processors/GithubDiscoveryProcessor.ts @@ -46,7 +46,7 @@ import { getOrganizationRepositories } from '../lib'; * target: https://github.com/backstage/*\/blob/main/catalog-info.yaml * * @public - **/ + */ export class GithubDiscoveryProcessor implements CatalogProcessor { private readonly integrations: ScmIntegrationRegistry; private readonly logger: Logger; diff --git a/plugins/search/src/components/SearchModal/SearchModal.tsx b/plugins/search/src/components/SearchModal/SearchModal.tsx index d17cf0f6ba..c9621c5940 100644 --- a/plugins/search/src/components/SearchModal/SearchModal.tsx +++ b/plugins/search/src/components/SearchModal/SearchModal.tsx @@ -42,7 +42,7 @@ import { rootRouteRef } from '../../plugin'; /** * @public - **/ + */ export interface SearchModalChildrenProps { /** * A function that should be invoked when navigating away from the modal. @@ -52,7 +52,7 @@ export interface SearchModalChildrenProps { /** * @public - **/ + */ export interface SearchModalProps { /** * If true, it renders the modal. diff --git a/plugins/stack-overflow/src/api/StackOverflowClient.ts b/plugins/stack-overflow/src/api/StackOverflowClient.ts index f4ff5bf190..f598f912bd 100644 --- a/plugins/stack-overflow/src/api/StackOverflowClient.ts +++ b/plugins/stack-overflow/src/api/StackOverflowClient.ts @@ -39,9 +39,8 @@ export class StackOverflowClient implements StackOverflowApi { } /** - * List Questions in the StackOverflow instance - * - * */ + * List questions in the StackOverflow instance + */ async listQuestions(options: { requestParams: StackOverflowQuestionsRequestParams; }): Promise { diff --git a/plugins/tech-insights-node/src/facts.ts b/plugins/tech-insights-node/src/facts.ts index 3619f8b66f..b35ad756ed 100644 --- a/plugins/tech-insights-node/src/facts.ts +++ b/plugins/tech-insights-node/src/facts.ts @@ -162,7 +162,7 @@ export interface FactRetriever { * \{ timeToLive: 1209600000 \} * \{ timeToLive: \{ weeks: 4 \} \} * - **/ + */ export type TTL = { timeToLive: DurationLike }; /** @@ -172,7 +172,7 @@ export type TTL = { timeToLive: DurationLike }; * @example * \{ maxItems: 10 \} * - **/ + */ export type MaxItems = { maxItems: number }; /**