Issue #49. Added unit tests for generated parse trees of Javadoc comments

30 files changed, 153 insertions, 0 deletions

diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/Input.java b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/Input.java
new file mode 100644
index 000000000..ee22870ad
--- /dev/null
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/Input.java
@@ -0,0 +1,4 @@
+/**
+ * <a>
+ */
+class A{}
\ No newline at end of file
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/LeadingAsterisks.txt b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/LeadingAsterisks.txt
new file mode 100644
index 000000000..070f5a220
--- /dev/null
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/LeadingAsterisks.txt
@@ -0,0 +1,3 @@
+
+  * Leading asterisk
+    * Another one
\ No newline at end of file
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/htmlTags/AttributeValueWithoutQuotes.txt b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/htmlTags/AttributeValueWithoutQuotes.txt
new file mode 100644
index 000000000..4cecd2ae1
--- /dev/null
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/htmlTags/AttributeValueWithoutQuotes.txt
@@ -0,0 +1 @@
+<a href=http://www.ietf.org/rfc/rfc3758.txt>RFC 3758</a>.
\ No newline at end of file
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/htmlTags/ClosedOtherTag.txt b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/htmlTags/ClosedOtherTag.txt
new file mode 100644
index 000000000..c9f4d7af8
--- /dev/null
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/htmlTags/ClosedOtherTag.txt
@@ -0,0 +1 @@
+ <dd></dt>
\ No newline at end of file
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/htmlTags/Comments.txt b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/htmlTags/Comments.txt
new file mode 100644
index 000000000..350b64871
--- /dev/null
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/htmlTags/Comments.txt
@@ -0,0 +1,2 @@
+ * Use <!-- standard
+ * java type --> <b>String</b>
\ No newline at end of file
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/htmlTags/HtmlTagsInParagraph.txt b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/htmlTags/HtmlTagsInParagraph.txt
new file mode 100644
index 000000000..156abc21c
--- /dev/null
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/htmlTags/HtmlTagsInParagraph.txt
@@ -0,0 +1,6 @@
+
+ * <p>
+ * <b>Description</b> <i>of</i> my class.
+ * </p>
+ * Another line of text
+ 
\ No newline at end of file
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/htmlTags/ListWithUnclosedItemInUnclosedParagraph.txt b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/htmlTags/ListWithUnclosedItemInUnclosedParagraph.txt
new file mode 100644
index 000000000..7d2a71ade
--- /dev/null
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/htmlTags/ListWithUnclosedItemInUnclosedParagraph.txt
@@ -0,0 +1,5 @@
+<p>
+<ul>
+	<li>item 1
+	<li>item 2</li>
+</ul>
\ No newline at end of file
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/htmlTags/MixedCaseOfHtmlTags.txt b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/htmlTags/MixedCaseOfHtmlTags.txt
new file mode 100644
index 000000000..98f2a3fcc
--- /dev/null
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/htmlTags/MixedCaseOfHtmlTags.txt
@@ -0,0 +1,10 @@
+<P>
+<br>
+<br/>
+<BR>
+<BR/>
+<TABLE>
+	<tr></TR>
+	<TR></tr>
+</table>
+</p>
\ No newline at end of file
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/htmlTags/NegativeNumberInAttribute.txt b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/htmlTags/NegativeNumberInAttribute.txt
new file mode 100644
index 000000000..f41c5aee9
--- /dev/null
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/htmlTags/NegativeNumberInAttribute.txt
@@ -0,0 +1 @@
+<font size=-2>TM</font>
\ No newline at end of file
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/htmlTags/OneSimpleHtmlTag.txt b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/htmlTags/OneSimpleHtmlTag.txt
new file mode 100644
index 000000000..1ea96c766
--- /dev/null
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/htmlTags/OneSimpleHtmlTag.txt
@@ -0,0 +1 @@
+<g>blabla</g>
\ No newline at end of file
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/htmlTags/UnclosedAndClosedParagraphs.txt b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/htmlTags/UnclosedAndClosedParagraphs.txt
new file mode 100644
index 000000000..d2534841d
--- /dev/null
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/htmlTags/UnclosedAndClosedParagraphs.txt
@@ -0,0 +1,5 @@
+<p>
+first paragraph
+<p>
+second paragraph
+</p>
\ No newline at end of file
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/htmlTags/UnclosedParagraphFollowedByJavadocTag.txt b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/htmlTags/UnclosedParagraphFollowedByJavadocTag.txt
new file mode 100644
index 000000000..00b892c0e
--- /dev/null
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/htmlTags/UnclosedParagraphFollowedByJavadocTag.txt
@@ -0,0 +1,3 @@
+<p style="color: red;">
+	text text
+@author Baratali
\ No newline at end of file
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/AllJavadocInlineTags.txt b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/AllJavadocInlineTags.txt
new file mode 100644
index 000000000..2701428d2
--- /dev/null
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/AllJavadocInlineTags.txt
@@ -0,0 +1 @@
+{@code <code>} {@literal <literal>} {@docRoot} {@inheritDoc} {@link A A class} {@linkplain A another link} {@value lang.Integer#MAX_VALUE}
\ No newline at end of file
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/AllStandardJavadocTags.txt b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/AllStandardJavadocTags.txt
new file mode 100644
index 000000000..ef5bd4a39
--- /dev/null
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/AllStandardJavadocTags.txt
@@ -0,0 +1,64 @@
+
+@author John Locke
+@author Man in black, Sub Zero
+@author <a href="mailto:meth@albuquerque.com">Walter White</a>
+@deprecated This method is deprecated
+because we created new one.
+@exception IOException throws exception if connection refused.
+@param arg String argument
+@param <E> it is generic
+@param type I can describe 'type'
+on several lines.
+One more line of description.
+@return something
+@return a value of element
+that is passed as argument.
+@see "A book of that famous man"
+@see <a href="http://google.com">Google</a>
+@see <a href="http://google.com">
+Google</a>
+@see java.lang.Integer#valueOf
+@see java.lang.Integer#Integer
+@see java.lang.Integer#MAX_VALUE
+@see java.lang.Integer#valueOf valueOf method
+@see java.lang.Integer#Integer Integer
+@see java.lang.Integer#MAX_VALUE maxValue
+@see java.lang.Integer#intValue method
+@see java.lang.Integer#intValue() method
+@see java.lang.Void#Void constructor
+@see java.lang.Void#Void() constructor
+@see java.lang.Integer#valueOf(String) method
+@see java.lang.Integer#toString(int,int) method
+@see java.lang.Integer#toString(int, int) method
+@see #field
+@see #method(Type, Type)
+@see #method(Type argname, Type argname)
+@see #constructor(Type, Type)
+@see #constructor(Type argname, Type argname)
+@see Class#field
+@see Class#method(Type, Type, Type)
+@see Class#method(Type argname, Type argname)
+@see Class#constructor(Type, Type)
+@see Class#constructor(Type argname, Type argname)
+@see Class.NestedClass
+@see Class
+@see com.github.checkstyle.Class#field
+@see com.github.checkstyle.Class#method(Type, Type)
+@see com.github.checkstyle.Class#method(Type argname, Type argname)
+@see com.github.checkstyle.Class#constructor(Type, Type)
+@see com.github.checkstyle.Class#constructor(Type argname, Type argname)
+@see com.github.checkstyle.Class.NestedClass
+@see com.github.checkstyle.Class
+@see com.github.checkstyle
+@serial field description
+on few lines
+and even here
+@serial include
+@serial exclude
+@serialField myField myObjectStreamField description of my serial field
+@serialData The data-description documents the types and order of data in the serialized form. Specifically, this data includes the optional data written by the writeObject method and all data (including base classes) written by the Externalizable.writeExternal method.
+@since 1.5
+@since Release 3.4.5
+@throws IOException throws exception if connection refused.
+@version 1.2
+@version Release 1.1.1
\ No newline at end of file
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/AsteriskInJavadocInlineTag.txt b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/AsteriskInJavadocInlineTag.txt
new file mode 100644
index 000000000..7ec113185
--- /dev/null
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/AsteriskInJavadocInlineTag.txt
@@ -0,0 +1,2 @@
+{@link
+  * GwtIncompatible}
\ No newline at end of file
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/AsteriskInLiteral.txt b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/AsteriskInLiteral.txt
new file mode 100644
index 000000000..03385c221
--- /dev/null
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/AsteriskInLiteral.txt
@@ -0,0 +1,2 @@
+{@literal as
+* as}
\ No newline at end of file
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/AuthorWithMailto.txt b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/AuthorWithMailto.txt
new file mode 100644
index 000000000..ddbc81bb3
--- /dev/null
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/AuthorWithMailto.txt
@@ -0,0 +1 @@
+@author <a href="mailto:barataliba@gmail.com">Baratali Izmailov</a>
\ No newline at end of file
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/CustomJavadocTags.txt b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/CustomJavadocTags.txt
new file mode 100644
index 000000000..2a507b316
--- /dev/null
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/CustomJavadocTags.txt
@@ -0,0 +1,4 @@
+ * @myTag yes it is
+ * @anotherTagWithoutParameter
+ * @author I
+ 
\ No newline at end of file
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/DocRootInheritDoc.txt b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/DocRootInheritDoc.txt
new file mode 100644
index 000000000..3f0dd01e7
--- /dev/null
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/DocRootInheritDoc.txt
@@ -0,0 +1,10 @@
+
+ * {@docRoot}
+ * {@docRoot }
+ * {@docRoot
+ * }
+ * {@inheritDoc}
+ * {@inheritDoc }
+ * {@inheritDoc
+ * }
+ 
\ No newline at end of file
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/FewWhiteSpacesAsSeparator.txt b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/FewWhiteSpacesAsSeparator.txt
new file mode 100644
index 000000000..eda5ad21f
--- /dev/null
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/FewWhiteSpacesAsSeparator.txt
@@ -0,0 +1 @@
+       * @param   initialCapacity     the initial capacity of the ByteBuffer.
\ No newline at end of file
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/InnerBracesInCodeTag.txt b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/InnerBracesInCodeTag.txt
new file mode 100644
index 000000000..ab0f6f399
--- /dev/null
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/InnerBracesInCodeTag.txt
@@ -0,0 +1 @@
+{@code {{{}}{{}}} }
\ No newline at end of file
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/JavadocTagDescriptionWithInlineTags.txt b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/JavadocTagDescriptionWithInlineTags.txt
new file mode 100644
index 000000000..0d828be43
--- /dev/null
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/JavadocTagDescriptionWithInlineTags.txt
@@ -0,0 +1 @@
+@deprecated use {@link java.lang.Integer Integer{@code <a>Wat</a>}} instead
\ No newline at end of file
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/LinkInlineTags.txt b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/LinkInlineTags.txt
new file mode 100644
index 000000000..71e2aa4c1
--- /dev/null
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/LinkInlineTags.txt
@@ -0,0 +1,2 @@
+{@link java.lang.Integer#valueOf}
+{@link java.lang.Integer#valueOf valueOf}
\ No newline at end of file
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/NewlineAndAsteriskInParameters.txt b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/NewlineAndAsteriskInParameters.txt
new file mode 100644
index 000000000..00c49ae2e
--- /dev/null
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/NewlineAndAsteriskInParameters.txt
@@ -0,0 +1,3 @@
+  * {@link ImmutableSortedMap#of(
+  *
+  * )}
\ No newline at end of file
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/ParamWithGeneric.txt b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/ParamWithGeneric.txt
new file mode 100644
index 000000000..6a40c99a9
--- /dev/null
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/ParamWithGeneric.txt
@@ -0,0 +1 @@
+@param <E> my favorite type
\ No newline at end of file
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/SeeReferenceWithFewNestedClasses.txt b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/SeeReferenceWithFewNestedClasses.txt
new file mode 100644
index 000000000..0939ca51a
--- /dev/null
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/SeeReferenceWithFewNestedClasses.txt
@@ -0,0 +1 @@
+@see java.lang.Integer.Nested.AnotherNested#someMethod(String, int) Description of the link
\ No newline at end of file
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/Serial.txt b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/Serial.txt
new file mode 100644
index 000000000..3302fea61
--- /dev/null
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/Serial.txt
@@ -0,0 +1,7 @@
+@serial field description
+on few lines
+and even here
+@serial include
+@serial exclude
+@serialField myField myObjectStreamField description of my serial field
+@serialData The data-description documents
\ No newline at end of file
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/Since.txt b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/Since.txt
new file mode 100644
index 000000000..25096fc78
--- /dev/null
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/Since.txt
@@ -0,0 +1,2 @@
+* @since 1.5
+ * @since Release 3.4.5
\ No newline at end of file
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/TextBeforeJavadocTags.txt b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/TextBeforeJavadocTags.txt
new file mode 100644
index 000000000..7b8c66e00
--- /dev/null
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/TextBeforeJavadocTags.txt
@@ -0,0 +1,7 @@
+
+ * a b
+ * c
+ * @see Integer Int
+ * @author Walter White
+ * @author John Snow
+ 
\ No newline at end of file
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/TwoLinkTagsInRow.txt b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/TwoLinkTagsInRow.txt
new file mode 100644
index 000000000..8de68299b
--- /dev/null
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/javadocTags/TwoLinkTagsInRow.txt
@@ -0,0 +1 @@
+{@link #WHITESPACE WHITESPACE}{@link #trimFrom trimFrom}
\ No newline at end of file