Examples

Before and after, taken from real runs of the CLI.

Convert

A typical JSDoc comment on an async function, converted line by line to TSDoc, with the reason for each change.

Why a bare @example breaks the TSDoc parser, and how convert fences only the bodies that need it.

How a JSDoc @typedef with @property tags becomes an interface whose members carry their own documentation, without losing any prose.

When a developer explained an export with // comments, convert can turn that prose into the doc comment it was already acting as.

What scaffold generates for components, interfaces and functions, and how the marker makes the review a search.

A field guide to the rule ids that check reports most often, what each one means, and the one-line fix.

How check picks a tsdoc.json in a monorepo, with a worked example of a tag that resolves in one package and not in its neighbour.