TouchInstinct
/
checkstyle
311
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Issue #3431: Documentation updated, baseIdentation variable renamed to baseIndentation

This commit is contained in:
kazachka 2016-10-24 18:06:27 +03:00 committed by Roman Ivanov
parent 5530d4c27d
commit 263b1502d8
2 changed files with 45 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/main/java/com/puppycrawl/tools/checkstyle/AstTreeStringPrinter.java
View File

@ -117,10 +117,10 @@ public final class AstTreeStringPrinter {
final DetailAST javadocBlock = node.getParent();
final DetailNode tree = DetailNodeTreeStringPrinter.parseJavadocAsDetailNode(javadocBlock);
String baseIdentation = getIndentation(node);
baseIdentation = baseIdentation.substring(0, baseIdentation.length() - 2);
final String rootPrefix = baseIdentation + " `--";
final String prefix = baseIdentation + " ";
String baseIndentation = getIndentation(node);
baseIndentation = baseIndentation.substring(0, baseIndentation.length() - 2);
final String rootPrefix = baseIndentation + " `--";
final String prefix = baseIndentation + " ";
return DetailNodeTreeStringPrinter.printTree(tree, rootPrefix, prefix);
}

79
src/xdocs/writingjavadocchecks.xml.vm
View File

@ -159,44 +159,47 @@ public class MyClass {
<source><![CDATA[
CLASS_DEF -> CLASS_DEF [5:0]
|--MODIFIERS -> MODIFIERS [5:0]
| |--JAVADOC -> \r\n * My <b>class</b>.\r\n * @see AbstractClass\r\n <EOF> [1:0]
| | |--NEWLINE -> \r\n [1:0]
| | |--LEADING_ASTERISK -> * [2:0]
| | |--TEXT -> My [2:2]
| | | |--WS -> [2:2]
| | | |--CHAR -> M [2:3]
| | | |--CHAR -> y [2:4]
| | | `--WS -> [2:5]
| | |--HTML_ELEMENT -> <b>class</b> [2:6]
| | | `--HTML_TAG -> <b>class</b> [2:6]
| | | |--HTML_ELEMENT_OPEN -> <b> [2:6]
| | | | |--OPEN -> < [2:6]
| | | | |--HTML_TAG_NAME -> b [2:7]
| | | | `--CLOSE -> > [2:8]
| | | |--TEXT -> class [2:9]
| | | | |--CHAR -> c [2:9]
| | | | |--CHAR -> l [2:10]
| | | | |--CHAR -> a [2:11]
| | | | |--CHAR -> s [2:12]
| | | | `--CHAR -> s [2:13]
| | | `--HTML_ELEMENT_CLOSE -> </b> [2:14]
| | | |--OPEN -> < [2:14]
| | | |--SLASH -> / [2:15]
| | | |--HTML_TAG_NAME -> b [2:16]
| | | `--CLOSE -> > [2:17]
| | |--TEXT -> . [2:18]
| | | `--CHAR -> . [2:18]
| | |--NEWLINE -> \r\n [2:19]
| | |--LEADING_ASTERISK -> * [3:0]
| | |--WS -> [3:2]
| | |--JAVADOC_TAG -> @see AbstractClass\r\n [3:3]
| | | |--SEE_LITERAL -> @see [3:3]
| | | |--WS -> [3:7]
| | | |--REFERENCE -> AbstractClass [3:8]
| | | | `--CLASS -> AbstractClass [3:8]
| | | |--NEWLINE -> \r\n [3:21]
| | | `--WS -> [4:0]
| | `--EOF -> <EOF> [4:1]
| |--BLOCK_COMMENT_BEGIN -> /* [1:0]
| | |--COMMENT_CONTENT -> *\n * My <b>class</b>.\n * @see AbstractClass\n [1:2]
| | | `--JAVADOC -> \n * My <b>class</b>.\n * @see AbstractClass\n <EOF> [1:0]
| | | |--NEWLINE -> \n [1:0]
| | | |--LEADING_ASTERISK -> * [2:0]
| | | |--TEXT -> My [2:2]
| | | | |--WS -> [2:2]
| | | | |--CHAR -> M [2:3]
| | | | |--CHAR -> y [2:4]
| | | | `--WS -> [2:5]
| | | |--HTML_ELEMENT -> <b>class</b> [2:6]
| | | | `--HTML_TAG -> <b>class</b> [2:6]
| | | | |--HTML_ELEMENT_OPEN -> <b> [2:6]
| | | | | |--OPEN -> < [2:6]
| | | | | |--HTML_TAG_NAME -> b [2:7]
| | | | | `--CLOSE -> > [2:8]
| | | | |--TEXT -> class [2:9]
| | | | | |--CHAR -> c [2:9]
| | | | | |--CHAR -> l [2:10]
| | | | | |--CHAR -> a [2:11]
| | | | | |--CHAR -> s [2:12]
| | | | | `--CHAR -> s [2:13]
| | | | `--HTML_ELEMENT_CLOSE -> </b> [2:14]
| | | | |--OPEN -> < [2:14]
| | | | |--SLASH -> / [2:15]
| | | | |--HTML_TAG_NAME -> b [2:16]
| | | | `--CLOSE -> > [2:17]
| | | |--TEXT -> . [2:18]
| | | | `--CHAR -> . [2:18]
| | | |--NEWLINE -> \n [2:19]
| | | |--LEADING_ASTERISK -> * [3:0]
| | | |--WS -> [3:2]
| | | |--JAVADOC_TAG -> @see AbstractClass\n [3:3]
| | | | |--SEE_LITERAL -> @see [3:3]
| | | | |--WS -> [3:7]
| | | | |--REFERENCE -> AbstractClass [3:8]
| | | | | `--CLASS -> AbstractClass [3:8]
| | | | |--NEWLINE -> \n [3:21]
| | | | `--WS -> [4:0]
| | | `--EOF -> <EOF> [4:1]
| | `--BLOCK_COMMENT_END -> */ [4:1]
| `--LITERAL_PUBLIC -> public [5:0]
|--LITERAL_CLASS -> class [5:7]
|--IDENT -> MyClass [5:13]