Format {@link} tags with monospace display text
Add explicit backtick-wrapped display text to all `{@link}` tags for
monospace rendering in TypeDoc output. This improves readability by:
- Using monospace font for code references (types, methods, functions)
- Stripping module prefixes from display text (e.g., `app!App.connect`
displays as `App.connect`)
Updated files across the SDK including `App`, `AppBridge`,
`PostMessageTransport`, React hooks, server helpers, types, and
documentation.
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
parent
43c30a7665
commit
9dd995562a
1 changed files with 217 additions and 217 deletions
|
|
@ -9,12 +9,12 @@ import { App } from "../app";
|
|||
*
|
||||
* The hook automatically cleans up the `ResizeObserver` when the component unmounts.
|
||||
*
|
||||
* **Note**: This hook is rarely needed since the {@link useApp} hook automatically enables
|
||||
* **Note**: This hook is rarely needed since the {@link useApp `useApp`} hook automatically enables
|
||||
* auto-resize by default. This hook is provided for advanced cases where you
|
||||
* create the {@link App} manually with `autoResize: false` and want to add auto-resize
|
||||
* create the {@link App `App`} manually with `autoResize: false` and want to add auto-resize
|
||||
* behavior later.
|
||||
*
|
||||
* @param app - The connected {@link App} instance, or null during initialization
|
||||
* @param app - The connected {@link App `App`} instance, or null during initialization
|
||||
* @param elementRef - Currently unused. The hook always observes `document.body`
|
||||
* and `document.documentElement` regardless of this value. Passing a ref will
|
||||
* cause unnecessary effect re-runs; omit this parameter.
|
||||
|
|
@ -22,9 +22,9 @@ import { App } from "../app";
|
|||
* @example Manual App creation with custom auto-resize control
|
||||
* {@includeCode ./useAutoResize.examples.tsx#useAutoResize_manualApp}
|
||||
*
|
||||
* @see {@link App.setupSizeChangedNotifications} for the underlying implementation
|
||||
* @see {@link useApp} which enables auto-resize by default
|
||||
* @see {@link App} constructor for configuring `autoResize` option
|
||||
* @see {@link App.setupSizeChangedNotifications `App.setupSizeChangedNotifications`} for the underlying implementation
|
||||
* @see {@link useApp `useApp`} which enables auto-resize by default
|
||||
* @see {@link App `App`} constructor for configuring `autoResize` option
|
||||
*/
|
||||
export function useAutoResize(
|
||||
app: App | null,
|
||||
|
|
|
|||
Loading…
Reference in a new issue