JSDoc to Markdown Converter

Maintaining API documentation by hand introduces drift between code and docs. JSDoc comment blocks follow a strict grammar defined by the JSDoc 3 specification: a description line, followed by block tags like @param, @returns, and @constructor. This tool parses those blocks, associates each with its immediately following declaration (function, class, or variable), and emits structured Markdown with parameter tables, return types, and access badges. It handles nested parameter notation such as options.prop by indenting sub-parameters under their parent row. Filtering modes replicate the CLI flags --only-public (emit only blocks bearing an explicit @public tag) and --exclude-private (suppress blocks marked @private). Note: the parser assumes well-formed JSDoc 3 syntax. Malformed blocks (missing closing */, orphan tags outside comment blocks) are silently skipped rather than producing corrupt output.

The converter operates as a three-stage pipeline: Extract → Parse → Render.

Each Block is a tuple of the raw comment text and the declaration line immediately following it. Extraction uses the regular expression pattern:

The parser then splits each block into lines, strips leading asterisks, and classifies each line as either a tag line or a continuation of the previous description. Tag lines match:

Filtering logic applies a predicate F over the parsed tag set T of each block:

Where T is the set of all tag names extracted from a given comment block, and @public and @private are string literals matched by exact equality. The renderer maps each parsed structure to its Markdown equivalent: function names become ## headings, parameters become pipe-delimited table rows with columns for Name, Type, and Description, and nested params (containing a dot separator) are indented with a non-breaking space prefix in the Name column.