ox_jsdoc 0.0.16

High-performance JSDoc parser with Binary AST format and lazy decoder, inspired by oxc
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

// @author kazuya kawaguchi (a.k.a. kazupon)
// @license MIT
//

//! Rust-side lazy decoder.
//!
//! See `design/007-binary-ast/rust-impl.md#rust-side-lazy-decoder` and
//! `js-decoder.md` (the JS counterpart) for the design rationale.
//!
//! The decoder is **stateless** with respect to the input bytes: every
//! lazy node struct is `Copy` and just remembers `(source_file, node_index)`.
//! Reads happen on demand from the underlying `&[u8]`.
//!
//! Module layout:
//!
//! - [`error`]: [`error::DecodeError`] enum.
//! - [`source_file`]: [`source_file::LazySourceFile`] (decoder root).
//! - [`helpers`]: shared low-level read helpers.
//! - [`nodes`]: lazy node structs (15 comment AST + 45 TypeNode = 60).
//! - [`visitor`]: [`visitor::LazyJsdocVisitor`] depth-first walker.

pub mod error;
pub mod helpers;
pub mod nodes;
pub mod source_file;
pub mod text;
pub mod visitor;

pub use error::DecodeError;
pub use nodes::{LazyNode, NodeListIter};
pub use source_file::LazySourceFile;
pub use visitor::LazyJsdocVisitor;