forge_doc/
lib.rs

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
33
//! The module for generating Solidity documentation.
//!
//! See [`DocBuilder`].

#![cfg_attr(not(test), warn(unused_crate_dependencies))]
#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]

#[macro_use]
extern crate foundry_common;

#[macro_use]
extern crate tracing;

mod builder;
pub use builder::DocBuilder;

mod document;
pub use document::Document;

mod helpers;

mod parser;
pub use parser::{
    error, Comment, CommentTag, Comments, CommentsRef, ParseItem, ParseSource, Parser,
};

mod preprocessor;
pub use preprocessor::*;

mod writer;
pub use writer::{AsDoc, AsDocResult, BufWriter, Markdown};

pub use mdbook;