Module hir_ext 

HIR-aware enrichments.

Pure functions over solar’s HIR:

• build_name_to_page: maps contract names to their MDX page paths.
• inheritance_links: **Inherits:** line for a contract page.
• natspec_doc: resolves effective NatSpec for a callable item.
• replace_inline_links: rewrites {Ident} to markdown links.

Structs

GetterField

One rendered row of a public variable getter signature (its name, ABI type and the inherited description).

LocalMembers

Members of the contract page currently being rendered.

NameToPage

Maps Solidity identifiers and HIR ids to their output MDX page paths relative to pages/.

NatSpecDoc

Effective NatSpec for an item, resolved by Solar and aligned with the item’s callable signature.

Enums

InheritedContract 🔒

Functions

build_name_to_page

Build the NameToPage index from HIR by re-deriving each item’s output path.

callable_function 🔒

clean_block_doc_content 🔒

Strip the * block-comment line decoration from each line of a /** */ NatSpec item’s content. Solar preserves raw source bytes, so continuation lines look like * text and blank separator lines look like *. This normalises them to plain text / empty lines.

continuation_parent 🔒

Returns the original tagged parent of a synthetic line-comment notice. The outer Option distinguishes a continuation from a standalone untagged notice; the inner value is None when Solar’s resolved view omitted the parent because a local section replaced it.

direct_base_items 🔒

doc_from_view 🔒

effective_natspec_doc 🔒

empty_natspec_doc 🔒

escape_link_label 🔒

Escape a string for use as a markdown link label.

exact_override_item 🔒

function_signature_anchor 🔒

function_source_param_types 🔒

Extracts function parameter types exactly as spelled in source for link anchors.

getter_field 🔒

implicit_edge_compatible 🔒

inheritance_links

Returns the **Inherits:** markdown string for a contract, or None if it has no bases.

insert_function_anchors 🔒

Record the heading and exact signature anchor for a rendered Solidity function.

natspec_doc

Resolves explicit NatSpec inheritance, or Foundry’s conservative implicit inheritance policy.

normalize_sol_type 🔒

Canonicalizes Solidity type aliases for generated link anchors.

normalized_natspec_content 🔒

page_link 🔒

Produce a vocs-style link from page relative to current_page.

parameter_names_equal 🔒

parse_inline_link 🔒

Parse {[xref-]Ident[-part]}[label] starting at offset 0 in s.

positional_description 🔒

push_non_yul_base_items 🔒

render_ty 🔒

Renders a resolved type as its ABI signature string.

replace_inline_links

Replace {Ident} and {xref-Ident} with markdown links using name_to_page.

resolve_page 🔒

Pick the best candidate page for a given cross-reference lookup.

slug_anchor_segment 🔒

source_paths 🔒

xref_part_anchor 🔒