Class JavaDocParserBuilder


  • public class JavaDocParserBuilder
    extends java.lang.Object
    Fluent builder to create a JavaDocParser instance.
    Author:
    chhorz
    • Field Detail

      • STANDARD_JAVADOC_TAGS

        public static final java.util.List<BlockTag> STANDARD_JAVADOC_TAGS
      • STANDARD_KDOC_TAGS

        public static final java.util.List<BlockTag> STANDARD_KDOC_TAGS
      • UNOFFICIAL_TAGS

        public static final java.util.List<BlockTag> UNOFFICIAL_TAGS
    • Method Detail

      • withoutTags

        public static JavaDocParserBuilder withoutTags()
        Create a new builder instance without any javadoc tags.
        Returns:
        a new builder instance
      • withTag

        public <T extends BlockTagJavaDocParserBuilder withTag​(T tag)
        Adds a javadoc tag to the parser instance.
        Type Parameters:
        T - type representation of the custom tag
        Parameters:
        tag - a new instance of the custom tag
        Returns:
        the updated builder instance
      • withOutputType

        public JavaDocParserBuilder withOutputType​(OutputType outputType)
        Adds string replacements based on regular expressions to convert JavaDoc format into the given output format.
        Parameters:
        outputType - the requested output type
        Returns:
        the fluent builder instance