Package com.github.chhorz.javadoc
Class JavaDocParserBuilder
java.lang.Object
com.github.chhorz.javadoc.JavaDocParserBuilder
Fluent builder to create a
JavaDocParser
instance.- Author:
- chhorz
-
Field Summary
FieldsModifier and TypeFieldDescription -
Method Summary
Modifier and TypeMethodDescriptionbuild()
Create theJavaDocParser
instance.static JavaDocParserBuilder
Creates a new builder instance with all known block tags ofSTANDARD_JAVADOC_TAGS
andSTANDARD_KDOC_TAGS
.withOutputType
(OutputType outputType) Adds string replacements based on regular expressions to convert JavaDoc format into the given output format.static JavaDocParserBuilder
Create a new builder instance without any javadoc tags.withReplacement
(Replacement replacement) Adds custom replacements for the output content.static JavaDocParserBuilder
Adds all tags from the official Oracle documentation.static JavaDocParserBuilder
Adds all tags from the official Kotlin documentation.<T extends BlockTag>
JavaDocParserBuilderwithTag
(T tag) Adds a javadoc tag to the parser instance.
-
Field Details
-
STANDARD_JAVADOC_TAGS
-
STANDARD_KDOC_TAGS
-
UNOFFICIAL_TAGS
-
-
Method Details
-
withoutTags
Create a new builder instance without any javadoc tags.- Returns:
- a new builder instance
-
withStandardJavadocTags
Adds all tags from the official Oracle documentation.- Returns:
- a new builder instance
-
withStandardKDocTags
Adds all tags from the official Kotlin documentation.- Returns:
- a new builder instance
-
withAllKnownTags
Creates a new builder instance with all known block tags ofSTANDARD_JAVADOC_TAGS
andSTANDARD_KDOC_TAGS
.- Returns:
- a new builder instance
-
withTag
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
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
-
withReplacement
Adds custom replacements for the output content.- Parameters:
replacement
- the replacement function- Returns:
- the fluent builder instance
- See Also:
-
build
Create theJavaDocParser
instance.- Returns:
- a new parser instance
-