Module render 

Rendering: solar AST -> vocs MDX.

Structs

CommentData 🔒

Ctx 🔒

Description 🔒

Links 🔒

The link environment for one page, including its local member anchors.

Enums

DescKind 🔒

Functions

collect_comments 🔒

Collect natspec from doc comments, applying inline link replacement.

dedent 🔒

Strip common leading whitespace from all non-empty lines.

escape_table_cell 🔒

Escape a value so it is safe inside a markdown (GFM) table cell:

fence_marker 🔒

fenced_description_regions 🔒

Complete fenced code blocks that are direct children of the description document. Restricting preservation to root-level blocks keeps list, quote, table, and unclosed-fence behavior on the conservative escaping path.

find_contract_id 🔒

Find the HIR ContractId for a contract by name, requiring the contract to live in the source file currently being rendered (compared via absolute path) so contracts that share a file stem across src/ and lib/ cannot collide.

first_notice 🔒

function_heading 🔒

function_signature_anchor 🔒

has_inheritdoc 🔒

has_local_natspec 🔒

Returns the base contract name from @inheritdoc Base, or None. Whether the declaration carries any local NatSpec item other than @inheritdoc. Solidity only auto-inherits documentation for a member with none, so implicit inheritance is gated on this being false; a local @custom:*, @title or @author counts as local documentation just like @notice/@dev/@param/@return.

is_complete_fence 🔒

is_known_custom_tag 🔒

Returns true if tag looks like a generally-recognised natspec custom tag.

italicize_dev 🔒

Italicize a @dev block by wrapping it in <i>...</i> HTML tags. Surrounding blank lines around the tags ensure MDX/CommonMark parses the inner content as block-level markdown (lists, code fences, multiple paragraphs all work).

neutralize_fence_markers 🔒

Keep rejected or incomplete fence markers from changing the Markdown context of subsequent descriptions. Entities render as the original marker characters without acting as syntax.

render_constants 🔒

render_contract 🔒

render_free_functions 🔒

render_function_section 🔒

replace_description_links 🔒

Replace inline links in a standalone notice or dev description while preserving complete, top-level fenced code blocks. Other NatSpec fields use replace_inline_links directly because their rendering context (notably table cells) cannot contain block-level Markdown.

return_description 🔒

sanitize_description_prose 🔒

source

Render a single Solidity source file as a list of (relative_output_path, mdx_content) pairs.

strip_one_ws 🔒

write_code_block 🔒

write_comment_block 🔒

write_deployments_table 🔒

Write the Deployments table for a contract page.

write_enum_variants_table 🔒

write_frontmatter 🔒

write_getter_table 🔒

Render a getter signature table (Parameters or Returns) from its inherited rows.

write_git_source 🔒

Write link if git_url is set.

write_item_body 🔒

Render the common body of a struct, enum, event, error, or value type.

write_page_header 🔒

write_param_table 🔒

write_signature_table_header 🔒

Common layout for parameters, returns, and struct properties.

write_struct_properties_table 🔒

yaml_escape_double_quoted 🔒

Escape a string for use as a YAML double-quoted scalar.