forge_doc/
lib.rs

1//! The module for generating Solidity documentation.
2//!
3//! See [`DocBuilder`].
4
5#![cfg_attr(not(test), warn(unused_crate_dependencies))]
6#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
7
8#[macro_use]
9extern crate foundry_common;
10
11#[macro_use]
12extern crate tracing;
13
14mod builder;
15pub use builder::DocBuilder;
16
17mod document;
18pub use document::Document;
19
20mod helpers;
21
22mod parser;
23pub use parser::{
24    error, Comment, CommentTag, Comments, CommentsRef, ParseItem, ParseSource, Parser,
25};
26
27mod preprocessor;
28pub use preprocessor::*;
29
30mod writer;
31pub use writer::{AsDoc, AsDocResult, BufWriter, Markdown};
32
33pub use mdbook;