public final class MultilineJavadocTagsCheck extends Check
This is how you should format javadoc tags that need a few lines:
/**
* This is my new method.
* @param text Some text information, provided to the
* method by another class
* @todo #123 I will implement it later, when more information
* come to light and I have documentation supplied by
* AAA team in the office accross the street
*/
public void func() {
// ...
}
Keep in mind that all free-text information should go before javadoc tags, or else it will treated as part of the latest tag and qulice will complain.
| Constructor and Description |
|---|
MultilineJavadocTagsCheck() |
| Modifier and Type | Method and Description |
|---|---|
int[] |
getDefaultTokens() |
void |
visitToken(DetailAST ast) |
beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLine, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokensgetCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverityconfigure, contextualize, finishLocalSetup, getConfiguration, setupChildpublic int[] getDefaultTokens()
getDefaultTokens in class Checkpublic void visitToken(DetailAST ast)
visitToken in class CheckCopyright © 2011–2016 Qulice.com. All rights reserved.