Skip to content

Commit 4b1908d

Browse files
mahfouz72nrmancuso
authored andcommitted
doc: remove outdated note about ANTLR versions in Javadoc vs Java grammar explanation
1 parent 0743036 commit 4b1908d

File tree

1 file changed

+0
-9
lines changed

1 file changed

+0
-9
lines changed

src/site/xdoc/writingjavadocchecks.xml.vm

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -196,15 +196,6 @@ public class MyClass {
196196
as block comments, whether they are Javadocs or not. Our Javadoc parser then transforms
197197
these block comment ASTs into our Javadoc AST.
198198
</p>
199-
<p>
200-
The difference is that Java grammar uses ANTLR v2, while Javadoc grammar uses ANTLR v4.
201-
Because of that, these two grammars and their trees are not compatible.
202-
Java AST consists of
203-
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/DetailAST.html">DetailAST</a>
204-
objects, while Javadoc AST consists of
205-
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/DetailNode.html">DetailNode</a>
206-
objects.
207-
</p>
208199
<p>
209200
Our Java grammar ignores whitespace in most cases, since Java itself does not care about
210201
whitespace; however, whitespace is critical in Javadocs. For this reason, our Javadoc AST

0 commit comments

Comments
 (0)