Package io.emop.javadocjson.parser

Interface JavadocParsingConfig

All Known Implementing Classes:
JDK9Dialet
public interface JavadocParsingConfig
Parsing configuration interface for supporting different versions of Javadoc parsing strategies

  • Method Details

    • getConfigName

      String getConfigName()
      Get configuration name
      Returns:
      configuration name

    • isApplicable

      boolean isApplicable(String htmlContent)
      Check if this configuration is applicable to the given HTML content
      Parameters:
      htmlContent - HTML content
      Returns:
      true if applicable, false otherwise

    • getMethodParsingConfig

      JavadocParsingConfig.MethodParsingConfig getMethodParsingConfig()
      Get method parsing configuration
      Returns:
      method parsing configuration

    • getFieldParsingConfig

      JavadocParsingConfig.FieldParsingConfig getFieldParsingConfig()
      Get field parsing configuration
      Returns:
      field parsing configuration

    • getAllClassesEntryPoint

      String getAllClassesEntryPoint()
      Get entry point for all classes page
      Returns:
      entry point

    • getClassInfoParsingConfig

      JavadocParsingConfig.ClassInfoParsingConfig getClassInfoParsingConfig()
      Get class basic information parsing configuration
      Returns:
      class basic information parsing configuration

    • getInheritanceParsingConfig

      JavadocParsingConfig.InheritanceParsingConfig getInheritanceParsingConfig()
      Get inheritance relationship parsing configuration
      Returns:
      inheritance relationship parsing configuration

    • getConstructorParsingConfig

      JavadocParsingConfig.ConstructorParsingConfig getConstructorParsingConfig()
      Get constructor parsing configuration
      Returns:
      constructor parsing configuration