Interface ExternalJavadocSupport

public interface ExternalJavadocSupport

  • Field Details

    • ANCHOR_PREFIX_END

      static final String ANCHOR_PREFIX_END
      See Also:

    • ANCHOR_PREFIX_START

      static final char[] ANCHOR_PREFIX_START

    • ANCHOR_PREFIX_START_2

      static final char[] ANCHOR_PREFIX_START_2

    • ANCHOR_PREFIX_START_LENGTH

      static final int ANCHOR_PREFIX_START_LENGTH

    • ANCHOR_PREFIX_START2_LENGTH

      static final int ANCHOR_PREFIX_START2_LENGTH

    • ANCHOR_SUFFIX

      static final char[] ANCHOR_SUFFIX

    • ANCHOR_SUFFIX_LENGTH

      static final int ANCHOR_SUFFIX_LENGTH

    • CONSTRUCTOR_DETAIL

      static final char[] CONSTRUCTOR_DETAIL

    • CONSTRUCTOR_SUMMARY

      static final char[] CONSTRUCTOR_SUMMARY

    • FIELD_DETAIL

      static final char[] FIELD_DETAIL

    • FIELD_SUMMARY

      static final char[] FIELD_SUMMARY

    • ENUM_CONSTANT_SUMMARY

      static final char[] ENUM_CONSTANT_SUMMARY

    • ANNOTATION_TYPE_REQUIRED_MEMBER_SUMMARY

      static final char[] ANNOTATION_TYPE_REQUIRED_MEMBER_SUMMARY

    • ANNOTATION_TYPE_OPTIONAL_MEMBER_SUMMARY

      static final char[] ANNOTATION_TYPE_OPTIONAL_MEMBER_SUMMARY

    • END_OF_CLASS_DATA

      static final char[] END_OF_CLASS_DATA

    • HTML_EXTENSION

      static final String HTML_EXTENSION
      See Also:

    • INDEX_FILE_NAME

      static final String INDEX_FILE_NAME
      See Also:

    • METHOD_DETAIL

      static final char[] METHOD_DETAIL

    • METHOD_SUMMARY

      static final char[] METHOD_SUMMARY

    • NESTED_CLASS_SUMMARY

      static final char[] NESTED_CLASS_SUMMARY

    • PACKAGE_FILE_NAME

      static final String PACKAGE_FILE_NAME
      See Also:

    • PACKAGE_DESCRIPTION_START

      static final char[] PACKAGE_DESCRIPTION_START

    • PACKAGE_DESCRIPTION_START2

      static final char[] PACKAGE_DESCRIPTION_START2

    • PACKAGE_DESCRIPTION_START3

      static final char[] PACKAGE_DESCRIPTION_START3

    • MODULE_FILE_SUFFIX

      static final String MODULE_FILE_SUFFIX
      See Also:

    • MODULE_DESCRIPTION_START

      static final char[] MODULE_DESCRIPTION_START

    • H2_PREFIX

      static final char[] H2_PREFIX

    • H2_SUFFIX

      static final char[] H2_SUFFIX

    • H2_SUFFIX_LENGTH

      static final int H2_SUFFIX_LENGTH

    • BOTTOM_NAVBAR

      static final char[] BOTTOM_NAVBAR

    • SEPARATOR_START

      static final char[] SEPARATOR_START

    • START_OF_CLASS_DATA

      static final char[] START_OF_CLASS_DATA

    • START_OF_CLASS_DATA_LENGTH

      static final int START_OF_CLASS_DATA_LENGTH

    • P

      static final String P
      See Also:

    • DIV_CLASS_BLOCK

      static final String DIV_CLASS_BLOCK
      See Also:

    • GENERATED_BY_JAVADOC

      static final String GENERATED_BY_JAVADOC
      See Also:

    • SECTION_PREFIX_START

      static final char[] SECTION_PREFIX_START

    • SECTION_SUFFIX

      static final char[] SECTION_SUFFIX

    • CONSTRUCTOR_NAME

      static final String CONSTRUCTOR_NAME
      See Also:

  • Method Details

    • forHtml

      static IJavadocContents forHtml(BinaryType type, String javadoc)
      Tries to create matching IJavadocContents object for javadoc content given
      Parameters:
      type - optional, can be null
      javadoc - javadoc content, can be null or empty
      Returns:
      IJavadocContents object for javadoc content given

    • guessVersion

      static int guessVersion(String javadocHtml)
      Tries to guess javadoc format version from given html.
      Parameters:
      javadocHtml - produced by javadoc
      Returns:
      -1 for unsupported version, otherwise possible javadoc format version. Note, any '1.' release is threaded as '1'.