Expand description
The module for generating Solidity documentation.
See DocBuilder.
Re-exports§
pub use mdbook;
Modules§
- builder 🔒
- document 🔒
- error
- Parser error.
- helpers 🔒
- parser 🔒
- The parser module.
- preprocessor 🔒
- Module containing documentation preprocessors.
- writer 🔒
- The module for writing and formatting various parse tree items.
Structs§
- BufWriter
- The buffered writer. Writes various display items into the internal buffer.
- Comment
- The natspec documentation comment.
- Comments
- The collection of natspec Comment items.
- Comments
Ref - The collection of references to natspec Comment items.
- Contract
Inheritance - The contract inheritance preprocessor.
- Deployment
- A contract deployment.
- Deployments
- The deployments preprocessor.
- DocBuilder
- Build Solidity documentation for a project from natspec comments. The builder parses the source files using Parser, then formats and writes the elements as the output.
- Document
- The wrapper around the ParseItem containing additional information the original item and extra context for outputting it.
- GitSource
- The git source preprocessor.
- Infer
Inline Hyperlinks - The infer hyperlinks preprocessor tries to map @dev tags to referenced items Traverses the documents and attempts to find referenced items comments for dev comment tags.
- Inheritdoc
- The inheritdoc preprocessor. Traverses the documents and attempts to find inherited comments for inheritdoc comment tags.
- Parse
Item - The parsed item.
- Parser
- The documentation parser. This type implements a [Visitor] trait.
- Preprocessor
Id - The preprocessor id.
Enums§
- Comment
Tag - The natspec comment tag explaining the purpose of the comment. See: https://docs.soliditylang.org/en/v0.8.17/natspec-format.html#tags.
- Markdown
- The markdown format.
- Parse
Source - A wrapper type around pt token.
- Preprocessor
Output - Preprocessor output. Wraps all existing preprocessor outputs in a single abstraction.
Constants§
- CONTRACT_
INHERITANCE_ ID - ContractInheritance preprocessor id.
- DEPLOYMENTS_
ID - Deployments preprocessor id.
- GIT_
SOURCE_ ID - GitSource preprocessor id.
- INFER_
INLINE_ HYPERLINKS_ ID - InferInlineHyperlinks preprocessor id.
- INHERITDOC_
ID Inheritdocpreprocessor ID.
Traits§
- AsDoc
- A trait for formatting a parse unit as documentation.
- Preprocessor
- Trait for preprocessing and/or modifying existing documents before writing the to disk.
Type Aliases§
- AsDoc
Result - The result of
AsDoc::as_doc.