docs: improve documentation formatting and type references

- Add {@linkcode} tags for type references
- Use backticks for code references
- Add blockquote syntax for notes
- Improve documentation consistency across files

Author: devin-ai-integration[bot]

browser/dom/_internal.ts

@@ -1,5 +1,5 @@
 /**
- * Encodes `AddEventListenerOptions` into a number for equality comparison.
+ * Encodes {@linkcode AddEventListenerOptions} into a number for equality comparison.
  * This function converts the options object into a single number where each bit
  * represents a specific option (capture, once, passive).
  */
@@ -16,16 +16,16 @@ export const encode = (
   );
 };
 /**
- * Decodes a number back into `AddEventListenerOptions` object.
+ * Decodes a number back into {@linkcode AddEventListenerOptions} object.
  * Each bit in the encoded number represents a specific option:
  *
  * - `capture`: `0b001` (bit 0)
  * - `once`: `0b010` (bit 1)
  * - `passive`: `0b100` (bit 2)
  * - `0`: returns `undefined`
  *
- * @param encoded The number containing encoded `AddEventListenerOptions` flags
- * @returns An `AddEventListenerOptions` object or `undefined` if encoded value is 0
+ * @param encoded The number containing encoded {@linkcode AddEventListenerOptions} flags
+ * @returns An {@linkcode AddEventListenerOptions} object or `undefined` if encoded value is 0
  */
 export const decode = (
   encoded: number,

browser/dom/cache.ts

@@ -2,7 +2,9 @@
  *
  * This function searches through the cache storage in reverse chronological order
  * to find the most recent cached response for a given request.
- * Implementation inspired by Scrapbox's ServiceWorker and Cache usage pattern.
+ * 
+ * > [!Note]
+ * > Implementation inspired by Scrapbox's ServiceWorker and Cache usage pattern.
  *
  * @param request The request to find a cached response for
  * @param options Cache query options (e.g., to ignore search params)
@@ -46,7 +48,8 @@ export const generateCacheName = (date: Date): string =>
  * 1. `"prefetch"` cache - temporary storage, cleared after first use
  * 2. `"api-yyyy-MM-dd"` cache - date-based persistent storage
  *
- * Note: Throws an exception if the network connection is slow
+ * > [!Note]
+ * > Throws an exception if the network connection is slow
  *
  * @param urls List of API URLs to prefetch
  */

browser/dom/caret.ts

@@ -1,21 +1,26 @@
 import { textInput } from "./dom.ts";
 
-/** Position information within the editor */
+/** Position information within the editor
+ * 
+ * @see {@linkcode Range} for selection range information
+ */
 export interface Position {
   /** Line number (1-based) */ line: number;
   /** Character offset within the line (0-based) */ char: number;
 }
 
 /** Represents a text selection range in the editor
  *
- * When no text is selected, start and end positions are the same (cursor position)
+ * When no text is selected, {@linkcode start} and {@linkcode end} positions are the same (cursor position)
+ * 
+ * @see {@linkcode Position} for position type details
  */
 export interface Range {
   /** Starting position of the selection */ start: Position;
   /** Ending position of the selection */ end: Position;
 }
 
-/** Cursor information contained within the React Component that builds #text-input */
+/** Cursor information contained within the React Component that builds `#text-input` */
 export interface CaretInfo {
   /** Current cursor position */ position: Position;
   /** Currently selected text */ selectedText: string;
@@ -35,7 +40,8 @@ interface ReactFiber {
 /** Retrieves the current cursor position and text selection information
  *
  * @return Information about cursor position and text selection
- * @throws {Error} When #text-input element or React Component's internal properties are not found
+ * @throws {Error} When `#text-input` element or React Component's internal properties are not found
+ * @see {@linkcode CaretInfo} for return type details
  */
 export const caret = (): CaretInfo => {
   const textarea = textInput();

browser/dom/cursor.d.ts

@@ -16,7 +16,11 @@ export interface SetPositionOptions {
   source?: "mouse";
 }
 
-/** Class for managing cursor operations in the Scrapbox editor */
+/** Class for managing cursor operations in the Scrapbox editor
+ * 
+ * @see {@linkcode Position} for cursor position type details
+ * @see {@linkcode Page} for page data type details
+ */
 export declare class Cursor extends BaseStore<
   { source: "mouse" | undefined } | "focusTextInput" | "scroll" | undefined
 > {
@@ -45,19 +49,19 @@ export declare class Cursor extends BaseStore<
   /** Hide the editor's popup menu */
   hidePopupMenu(): void;
 
-  /** Focus the cursor on #text-input and make it visible
+  /** Focus the cursor on `#text-input` and make it visible
    *
    * This action triggers the `event: "focusTextInput"` event
    */
   focus(): void;
 
-  /** Check if #text-input has focus
+  /** Check if `#text-input` has focus
    *
    * Returns the same value as `this.focusTextarea`
    */
   get hasFocus(): boolean;
 
-  /** Remove focus from #text-input without changing cursor visibility */
+  /** Remove focus from `#text-input` without changing cursor visibility */
   blur(): void;
 
   /** Adjust cursor position to stay within valid line and column boundaries */
@@ -71,13 +75,13 @@ export declare class Cursor extends BaseStore<
 
   /** Make the cursor visible
    *
-   * Does not change the focus state of #text-input
+   * Does not change the focus state of `#text-input`
    */
   show(): void;
 
   /** Hide the cursor
    *
-   * On touch devices, this also removes focus from #text-input
+   * On touch devices, this also removes focus from `#text-input`
    */
   hide(): void;