Interface JavaDocTagHandler
-
- All Known Implementing Classes:
DefaultJavaDocTagHandler
public interface JavaDocTagHandlerHandler to be used to define logic to perform for tags in JavaDoc comments.- Author:
- Ryan Heaton
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetTypeId()The id of the type of this tag handler.StringonBlockTag(String tagName, String value, DecoratedElement context)What to do with a block JavaDoc tag.StringonInlineTag(String tagName, String tagText, DecoratedElement context)What to do with an inline JavaDoc tag.
-
-
-
Method Detail
-
getTypeId
String getTypeId()
The id of the type of this tag handler.- Returns:
- The id of the type of this tag handler.
-
onInlineTag
String onInlineTag(String tagName, String tagText, DecoratedElement context)
What to do with an inline JavaDoc tag.- Parameters:
tagName- The tag name.tagText- The tag text.context- The context of the text.- Returns:
- The text to replace the entire tag, or null for no replacement.
-
onBlockTag
String onBlockTag(String tagName, String value, DecoratedElement context)
What to do with a block JavaDoc tag.- Parameters:
tagName- The tag name.value- the tag value.context- the context of the text.- Returns:
- The text to replace the value.
-
-