Skip to main content Module hover Copy item path Source DocEntry Merged documentation from solc userdoc + devdoc for a single declaration. DocKey Key for looking up documentation in the DocIndex build_doc_index Build a documentation index from normalized AST output. extract_documentation Extract documentation text from a node.
Handles both object form {text: "..."} and plain string form. extract_selector Extract the selector from a declaration node. find_node_by_id Find the raw AST node with the given id by walking all sources. format_doc_entry Format a DocEntry as markdown for hover display. format_natspec Format NatSpec documentation as markdown.
Strips leading @ tags and formats them nicely.
When inherited_doc is provided, it replaces @inheritdoc lines with the resolved content. hover_info Produce hover information for the symbol at the given position. lookup_doc_entry Look up documentation for an AST declaration node from the DocIndex. lookup_param_doc Look up documentation for a parameter from its parent function/error/event. resolve_inheritdoc Resolve @inheritdoc ParentName by matching function selectors. DocIndex Pre-built documentation index from solc contract output.