@OpenApiAll
public class DocumentParser
extends java.lang.Object
Document
.Constructor and Description |
---|
DocumentParser(com.nomagic.magicreport.engine.ITool tool)
Create the parser.
|
Modifier and Type | Method and Description |
---|---|
Document |
getDocument()
Return a
Document from comment string. |
void |
handleComment(java.lang.String text)
Called when a JavaDoc comment is encountered.
|
void |
handleInlineTag(java.lang.String blockTag,
java.lang.String inlineTag,
java.lang.String text)
Called when a JavaDoc inline tag is encountered.
|
void |
handleTag(java.lang.String tagName,
java.lang.String text)
Called when a JavaDoc block tag is encountered.
|
void |
parse(java.lang.String commentText)
Parse the comment string.
|
void |
parseText(java.lang.String commentText)
Parse the comment string in plain text format.
|
public DocumentParser(com.nomagic.magicreport.engine.ITool tool)
tool
- Document Toolpublic Document getDocument()
Document
from comment string.Document
public void parse(java.lang.String commentText) throws DocumentException
commentText
- input string with /** and end with *DocumentException
- when error while parsing document.public void parseText(java.lang.String commentText) throws DocumentException
commentText
- input stringDocumentException
- when error while parsing document.public void handleTag(java.lang.String tagName, java.lang.String text)
tagName
- tag nametext
- text commentpublic void handleInlineTag(java.lang.String blockTag, java.lang.String inlineTag, java.lang.String text)
blockTag
- block tag nameinlineTag
- inline tag nametext
- text commentpublic void handleComment(java.lang.String text)
text
- text commentCopyright © 2015 - No Magic Asia