public final class MultilineJavadocTagsCheck extends AbstractCheck
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.
AutomaticBean.OutputStreamOptions| Constructor and Description |
|---|
MultilineJavadocTagsCheck() |
| Modifier and Type | Method and Description |
|---|---|
int[] |
getAcceptableTokens() |
int[] |
getDefaultTokens() |
int[] |
getRequiredTokens() |
void |
visitToken(DetailAST ast) |
beginTree, clearMessages, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, log, setClassLoader, setFileContents, setTabWidth, setTokensfinishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverityconfigure, contextualize, getConfiguration, setupChildpublic int[] getDefaultTokens()
getDefaultTokens in class AbstractCheckpublic int[] getAcceptableTokens()
getAcceptableTokens in class AbstractCheckpublic int[] getRequiredTokens()
getRequiredTokens in class AbstractCheckpublic void visitToken(DetailAST ast)
visitToken in class AbstractCheckCopyright © 2011–2019 Qulice.com. All rights reserved.