mirror of
https://github.com/oxc-project/oxc.git
synced 2026-09-14 19:36:11 +08:00
00e1b762e0
We no longer need to maintain the `oxc-miette` repo as most of the code is now removed, the remaining code is minimal and can be vendored.
Oxc JSDoc
JSDoc comment parsing for the oxc toolchain.
Overview
This crate provides JSDoc comment parsing functionality, extracting structured data from JSDoc comments (/** ... */). It handles parsing of tags, types, parameter names, and descriptions.
Key Features
- Lazy parsing: JSDoc comments are parsed on first access via
OnceCell - Tag extraction: Supports
@param,@returns,@type,@typedef, and arbitrary custom tags - Type parsing: Extracts
{type}expressions from tags - Name parsing: Handles parameter names including optional
[name=default]syntax - Comment parsing: Strips JSDoc formatting (
*prefixes, indentation) - Span tracking: All parsed parts include source position spans