JavaDoc Tool is a custom tool class used for creating a Document node.
Document is an interface representing a Comment Document.
DocumentImpl is a default JavaDoc document implementation.
Tag is an interface representing a simple documentation tag, such as @since, @author, and @version
TagImpl is a default tag implementation.
ParamTag represents a @param documentation tag.
ThrowsTag represents a @throws or @exception documentation tag.
SeeTag represents a user-defined cross-reference to related documentation. The reference can be either inline with the comment using {@link} or a separate block comment using @see.
SerialFieldTag represents a @serialField tag.
For examples:
#import ("javadoc", "com.nomagic.reportwizard.tools.doc.JavaDocTool") #set ($doc = $javadoc.create($comment)) |
$doc.comment |
$doc.author |
#foreach ($author in $doc.getTags("author")) $author.text #end |
#foreach ($tag in $doc.firstSentenceTags) $tag.text #end |
#foreach ($tag in $doc.inlineTags) $tag.kind $tag.text #end |
$doc.rawComment |
#foreach ($tag in $doc.tags) $tag.kind : $tag.text #end |
#foreach ($tag in $doc.getTags("param")) $tag.name - $tag.comment #end |
#foreach ($tag in $doc.getTags("throws")) $tag.name - $tag.comment #end |
#foreach ($tag in $doc.getTags("see")) $tag.label - $tag.reference #end |
Reference Documents
|