Skip to main content

Module builder

Module builder 

Source

Structsยง

BuildStats
Summary stats produced by DocBuilder::build, surfaced to the user as progress feedback by forge doc.
DocBuilder
Build Solidity documentation for a project from natspec comments using solar.

Functionsยง

update_manifest ๐Ÿ”’
The manifest is the ownership boundary: only previously generated pages can be pruned.
write_pages ๐Ÿ”’
Write successful pages, but do not change ownership or prune if a user source failed.

Type Aliasesยง

RenderResult ๐Ÿ”’
Successful pages or the path of a user source whose renderer panicked.