Package io.emop.javadocjson.parser

Interface JavadocParsingConfig.MethodParsingConfig

Enclosing interface:
JavadocParsingConfig
public static interface JavadocParsingConfig.MethodParsingConfig
Method parsing configuration interface

  • Method Details

    • getMethodSelector

      String getMethodSelector()
      Get method selector
      Returns:
      CSS selector string

    • extractMethodName

      String extractMethodName(org.jsoup.nodes.Element methodElement)
      Extract method name from element
      Parameters:
      methodElement - method element
      Returns:
      method name

    • extractMethodNameWithParameters

      String extractMethodNameWithParameters(org.jsoup.nodes.Element methodElement)
      Method with parameters, e.g. valueOf(java.lang.String name)
      Parameters:
      methodElement - method element
      Returns:
      method with parameters

    • extractModifierAndType

      String extractModifierAndType(org.jsoup.nodes.Element methodElement)
      Extract modifiers and type from element
      Parameters:
      methodElement - method element
      Returns:
      modifiers and type

    • extractDescription

      String extractDescription(org.jsoup.nodes.Element methodElement)
      Extract description from element
      Parameters:
      methodElement - method element
      Returns:
      description

    • extractDetailText

      String extractDetailText(org.jsoup.nodes.Element methodElement, org.jsoup.nodes.Document doc)
      Extract raw text from element
      Parameters:
      methodElement - method element
      doc - the full class document
      Returns:
      raw text

    • isValidMethodElement

      boolean isValidMethodElement(org.jsoup.nodes.Element element)
      Validate if element is a valid method element
      Parameters:
      element - element to validate
      Returns:
      true if it's a valid method element, false otherwise