From 3d24ddab53a6d328adca23d2356e68d4821a1d57 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Kan=C4=9Bra?= Date: Tue, 7 Jul 2026 20:04:16 +0200 Subject: [PATCH] docs(react): rewrite @see URLs as markdown links Bare @see URLs rendered with the path tail as link text (Paper#wakeUp) in the generated API reference, and the #wakeUp anchor didn't match the lowercase Docusaurus slug. Markdown links give readable text and correct anchors; the docs converter preserves both. --- .../joint-react/src/components/graph/graph-provider.tsx | 4 ++-- packages/joint-react/src/components/paper/paper.types.ts | 2 +- packages/joint-react/src/hooks/use-paper.ts | 8 ++++---- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/packages/joint-react/src/components/graph/graph-provider.tsx b/packages/joint-react/src/components/graph/graph-provider.tsx index e90a5c2f99..e94c72749d 100644 --- a/packages/joint-react/src/components/graph/graph-provider.tsx +++ b/packages/joint-react/src/components/graph/graph-provider.tsx @@ -27,7 +27,7 @@ export interface GraphProviderProps< /** * Pre-existing JointJS graph instance to use. If omitted, GraphProvider * creates a fresh `new dia.Graph(...)`. - * @see https://docs.jointjs.com/api/dia/Graph + * @see [`dia.Graph`](https://docs.jointjs.com/api/dia/Graph) */ readonly graph?: dia.Graph; /** React children rendered inside the provider, typically a ``. */ @@ -43,7 +43,7 @@ export interface GraphProviderProps< * Base model class used for every cell the graph constructs from JSON. Maps to * the (deprecated) `cellModel` option of `dia.Graph`; prefer `cellNamespace`, * which registers shapes by `type` and supports per-type model classes. - * @see https://docs.jointjs.com/api/dia/Graph + * @see [`dia.Graph`](https://docs.jointjs.com/api/dia/Graph) */ readonly cellModel?: typeof dia.Cell; /** diff --git a/packages/joint-react/src/components/paper/paper.types.ts b/packages/joint-react/src/components/paper/paper.types.ts index 3c31a6ee41..1dbddb76b9 100644 --- a/packages/joint-react/src/components/paper/paper.types.ts +++ b/packages/joint-react/src/components/paper/paper.types.ts @@ -379,7 +379,7 @@ export type RenderLink = (data: LinkData) => ReactNode; * re-subscription on render. For raw native event names or events without an * `on*` form (`render:done`, `cell:highlight`, …), use the {@link useOnPaperEvents} * hook. - * @see https://docs.jointjs.com/api/dia/Paper + * @see [`dia.Paper`](https://docs.jointjs.com/api/dia/Paper) * @expand * @group Types */ diff --git a/packages/joint-react/src/hooks/use-paper.ts b/packages/joint-react/src/hooks/use-paper.ts index f8e7b7f186..33e0d10090 100644 --- a/packages/joint-react/src/hooks/use-paper.ts +++ b/packages/joint-react/src/hooks/use-paper.ts @@ -80,19 +80,19 @@ export interface PaperApi { /** * Trigger a render pass on the paper. Forwards to `paper.wakeUp()`. * No-op when the paper isn't resolved yet. - * @see https://docs.jointjs.com/api/dia/Paper#wakeUp + * @see [`paper.wakeUp()`](https://docs.jointjs.com/api/dia/Paper#wakeup) */ readonly wakeUp: () => void; /** * Suspend view updates so edits don't repaint until {@link PaperApi.unfreeze}. * Forwards to `paper.freeze()`. No-op when the paper isn't resolved yet. - * @see https://docs.jointjs.com/api/dia/Paper#freeze + * @see [`paper.freeze()`](https://docs.jointjs.com/api/dia/Paper#freeze) */ readonly freeze: () => void; /** * Resume view updates and flush everything queued while frozen. Forwards to * `paper.unfreeze()`. No-op when the paper isn't resolved yet. - * @see https://docs.jointjs.com/api/dia/Paper#unfreeze + * @see [`paper.unfreeze()`](https://docs.jointjs.com/api/dia/Paper#unfreeze) */ readonly unfreeze: () => void; } @@ -109,7 +109,7 @@ export interface PaperApi { * @param paperId - An explicit paper id, or omitted for the context/default paper. * @returns The {@link PaperApi}: the resolved `paper` (or `null`) plus `wakeUp`, * `freeze`, and `unfreeze` actions. - * @see https://docs.jointjs.com/learn/quickstart/paper + * @see [Paper quickstart](https://docs.jointjs.com/learn/quickstart/paper) * @group Hooks * @example * ```tsx