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
|
|
@ -29,8 +29,8 @@ import {
|
|||
* **Host**:
|
||||
* {@includeCode ./message-transport.examples.ts#PostMessageTransport_host}
|
||||
*
|
||||
* @see {@link app!App.connect} for Guest UI usage
|
||||
* @see {@link app-bridge!AppBridge.connect} for Host usage
|
||||
* @see {@link app!App.connect `App.connect`} for Guest UI usage
|
||||
* @see {@link app-bridge!AppBridge.connect `AppBridge.connect`} for Host usage
|
||||
*/
|
||||
export class PostMessageTransport implements Transport {
|
||||
private messageListener: (
|
||||
|
|
@ -102,7 +102,7 @@ export class PostMessageTransport implements Transport {
|
|||
/**
|
||||
* Stop listening for messages and cleanup.
|
||||
*
|
||||
* Removes the message event listener and calls the {@link onclose} callback if set.
|
||||
* Removes the message event listener and calls the {@link onclose `onclose`} callback if set.
|
||||
*/
|
||||
async close() {
|
||||
window.removeEventListener("message", this.messageListener);
|
||||
|
|
@ -112,7 +112,7 @@ export class PostMessageTransport implements Transport {
|
|||
/**
|
||||
* Called when the transport is closed.
|
||||
*
|
||||
* Set this handler to be notified when {@link close} is called.
|
||||
* Set this handler to be notified when {@link close `close`} is called.
|
||||
*/
|
||||
onclose?: () => void;
|
||||
|
||||
|
|
@ -129,7 +129,7 @@ export class PostMessageTransport implements Transport {
|
|||
/**
|
||||
* Called when a valid JSON-RPC message is received.
|
||||
*
|
||||
* This handler is invoked after message validation succeeds. The {@link start}
|
||||
* This handler is invoked after message validation succeeds. The {@link start `start`}
|
||||
* method must be called before messages will be received.
|
||||
*
|
||||
* @param message - The validated JSON-RPC message
|
||||
|
|
|
|||
Loading…
Reference in a new issue