Skip to main content

resolve_inheritdoc

Function resolve_inheritdoc 

Source
pub fn resolve_inheritdoc<'a>(
    sources: &'a Value,
    decl_node: &'a Value,
    doc_text: &str,
) -> Option<String>
Expand description

Resolve @inheritdoc ParentName by matching function selectors.

  1. Parse the parent contract name from @inheritdoc ParentName
  2. Get the declaration’s functionSelector
  3. Find the parent contract in baseContracts of the scope contract
  4. Match by selector in the parent’s child nodes
  5. Return the matched parent node’s documentation