Package | Description |
---|---|
com.puppycrawl.tools.checkstyle |
Contains the implementation of the Checkstyle framework.
|
com.puppycrawl.tools.checkstyle.api |
Contains the core API to be used to implement checks.
|
com.puppycrawl.tools.checkstyle.checks.javadoc |
Contains the Javadoc checks that are bundled with the main distribution.
|
com.puppycrawl.tools.checkstyle.gui |
User interface classes for CheckStyle.
|
com.puppycrawl.tools.checkstyle.utils |
Contains utils classes for checkstyle.
|
Modifier and Type | Method and Description |
---|---|
DetailNode |
JavadocDetailNodeParser.ParseStatus.getTree()
Getter for DetailNode tree.
|
static DetailNode |
DetailNodeTreeStringPrinter.parseJavadocAsDetailNode(DetailAST blockComment)
Parse block comment DetailAST as Javadoc DetailNode tree.
|
Modifier and Type | Method and Description |
---|---|
static String |
DetailNodeTreeStringPrinter.printTree(DetailNode ast,
String rootPrefix,
String prefix)
Print AST.
|
void |
JavadocDetailNodeParser.ParseStatus.setTree(DetailNode tree)
Sets DetailNode tree.
|
Modifier and Type | Method and Description |
---|---|
DetailNode[] |
DetailNode.getChildren()
Array of children.
|
DetailNode |
DetailNode.getParent()
Parent node.
|
Modifier and Type | Class and Description |
---|---|
class |
JavadocNodeImpl
Implementation of DetailNode interface that is mutable.
|
Modifier and Type | Method and Description |
---|---|
DetailNode[] |
JavadocNodeImpl.getChildren() |
DetailNode |
JavadocNodeImpl.getParent() |
Modifier and Type | Method and Description |
---|---|
void |
AbstractJavadocCheck.beginJavadocTree(DetailNode rootAst)
Called before the starting to process a tree.
|
void |
AbstractJavadocCheck.finishJavadocTree(DetailNode rootAst)
Called after finished processing a tree.
|
void |
AbstractJavadocCheck.leaveJavadocToken(DetailNode ast)
Called after all the child nodes have been process.
|
void |
JavadocNodeImpl.setChildren(DetailNode... children)
Sets array of child nodes.
|
void |
JavadocNodeImpl.setParent(DetailNode parent)
Sets parent node.
|
void |
SummaryJavadocCheck.visitJavadocToken(DetailNode ast) |
void |
SingleLineJavadocCheck.visitJavadocToken(DetailNode ast) |
void |
NonEmptyAtclauseDescriptionCheck.visitJavadocToken(DetailNode ast) |
void |
JavadocTagContinuationIndentationCheck.visitJavadocToken(DetailNode ast) |
void |
JavadocParagraphCheck.visitJavadocToken(DetailNode ast) |
void |
AtclauseOrderCheck.visitJavadocToken(DetailNode ast) |
abstract void |
AbstractJavadocCheck.visitJavadocToken(DetailNode ast)
Called to process a Javadoc token.
|
Constructor and Description |
---|
CodeSelectorPresentation(DetailNode node,
com.google.common.collect.ImmutableList<Integer> lines2position)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
static DetailNode |
JavadocUtils.findFirstToken(DetailNode detailNode,
int type)
Returns the first child token that has a specified type.
|
static DetailNode |
JavadocUtils.getFirstChild(DetailNode node)
Gets first child node of specified node.
|
static DetailNode |
JavadocUtils.getNextSibling(DetailNode node)
Gets next sibling of specified node.
|
static DetailNode |
JavadocUtils.getNextSibling(DetailNode node,
int tokenType)
Gets next sibling of specified node with the specified type.
|
static DetailNode |
JavadocUtils.getPreviousSibling(DetailNode node)
Gets previous sibling of specified node.
|
Modifier and Type | Method and Description |
---|---|
static boolean |
JavadocUtils.containsInBranch(DetailNode node,
int type)
Checks whether node contains any node of specified type among children on any deep level.
|
static DetailNode |
JavadocUtils.findFirstToken(DetailNode detailNode,
int type)
Returns the first child token that has a specified type.
|
static DetailNode |
JavadocUtils.getFirstChild(DetailNode node)
Gets first child node of specified node.
|
static DetailNode |
JavadocUtils.getNextSibling(DetailNode node)
Gets next sibling of specified node.
|
static DetailNode |
JavadocUtils.getNextSibling(DetailNode node,
int tokenType)
Gets next sibling of specified node with the specified type.
|
static DetailNode |
JavadocUtils.getPreviousSibling(DetailNode node)
Gets previous sibling of specified node.
|
static String |
JavadocUtils.getTagName(DetailNode javadocTagSection)
Gets tag name from javadocTagSection.
|
Copyright © 2001–2018. All rights reserved.