jsdoclisted

# JSDoc The detailed JSDoc format guide. The essentials live in the `jsdoc` rule; reach here for the full reference, including every `@example` format and documentation pattern in [references/examples.md](references/examples.md). ## `@example` format, in brief - Short value: label on the `@example` line, code as inline backtick on the next line. - Multi-line code: a fenced ` ```ts ``` ` block immediately after `@example`, never bare lines. - Multiple variants: separate `@example` blocks, one concern each, never one example for every case. See [references/examples.md](references/examples.md) for a worked example of each, plus the property, enum, nested-property, and function documentation patterns. ## Tags ### Use frequently | Tag | Purpose | Notes | | ------------- | ------------------ | ----------------------------------------------------------- | | `@default` | Default value | Only when the default is non-obvious (omit for `undefined`) | | `@example` | Usage example | Prefer for complex or multi-variant APIs | | `@note` | Important caveat | Version info, breaking changes | | `@deprecated` | Mark as deprecated | Include a migration path | ### Use sparingly | Tag | Purpose | | ----------- | ----------------------- | | `@see` | Reference external docs | | `@i