Skip to content

Commit c0eaad7

Browse files
committed
doc fixes for generated ocapi clients
1 parent fd2410e commit c0eaad7

File tree

4 files changed

+5
-4
lines changed

4 files changed

+5
-4
lines changed

packages/b2c-tooling/src/clients/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
*
1212
* ## Usage
1313
*
14-
* **Note:** These clients are typically accessed via {@link B2CInstance} rather than
14+
* **Note:** These clients are typically accessed via `B2CInstance` rather than
1515
* instantiated directly. The `B2CInstance` class handles authentication setup
1616
* and provides convenient `webdav` and `ocapi` getters.
1717
*

packages/b2c-tooling/src/clients/ocapi.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ export type {paths, components};
2121
/**
2222
* The typed OCAPI client - this is the openapi-fetch Client with full type safety.
2323
*
24-
* **Note:** This client is typically accessed via {@link B2CInstance.ocapi} rather
24+
* **Note:** This client is typically accessed via `B2CInstance.ocapi` rather
2525
* than created directly. The `B2CInstance` class handles authentication setup.
2626
*
2727
* @see {@link createOcapiClient} for direct instantiation
@@ -134,7 +134,7 @@ export function createLoggingMiddleware(): Middleware {
134134
* handled via middleware. This gives full access to all openapi-fetch
135135
* features with type-safe paths, parameters, and responses.
136136
*
137-
* **Note:** This client is typically accessed via {@link B2CInstance.ocapi} rather
137+
* **Note:** This client is typically accessed via `B2CInstance.ocapi` rather
138138
* than created directly. The `B2CInstance` class handles authentication setup.
139139
*
140140
* @param hostname - B2C instance hostname

packages/b2c-tooling/src/clients/webdav.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ export interface PropfindEntry {
2727
* Handles WebDAV requests with proper authentication and provides
2828
* typed methods for common operations.
2929
*
30-
* **Note:** This client is typically accessed via {@link B2CInstance.webdav} rather
30+
* **Note:** This client is typically accessed via `B2CInstance.webdav` rather
3131
* than instantiated directly. The `B2CInstance` class handles authentication setup.
3232
*
3333
* @example

typedoc.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
"./packages/b2c-tooling/src/i18n/index.ts",
1212
"./packages/b2c-tooling/src/logging/index.ts"
1313
],
14+
"exclude": ["**/*.generated.ts"],
1415
"out": "./docs/api",
1516
"plugin": ["typedoc-plugin-markdown", "typedoc-vitepress-theme"],
1617
"tsconfig": "./packages/b2c-tooling/tsconfig.json",

0 commit comments

Comments
 (0)