tsdoc_mdz.ts

Bridge between TSDoc format and mdz for rendering.

This module converts raw TSDoc syntax (from the analysis library) to mdz format (Fuz's documentation rendering dialect). It lives in fuz_ui, not the extracted analysis library, to keep that library format-agnostic.

Declarations
#

view source

tsdoc_see_to_mdz
#

tsdoc_mdz.ts view source

(content: string): string

Convert raw TSDoc @see content to mdz format for rendering.

Handles TSDoc link syntax: - |text → [text](url) (markdown link) - ://... → https://... (bare URL, auto-linked by mdz) - `` → `` identifier `` (code formatting) - Bare URLs → returned as-is - Bare identifiers → wrapped in backticks

content

Raw @see tag content in TSDoc format

type string

returns

string

mdz-formatted string ready for Mdz component

examples

tsdoc_see_to_mdz('://fuz.dev|API Docs') // → '[API Docs](https://fuz.dev)' tsdoc_see_to_mdz('') // → '`SomeType`' tsdoc_see_to_mdz('https://example.com') // → 'https://example.com'

Depends on
#

Imported by
#