Issue checkstyle#4408: m

voidfist · Jun 27, 2017 · 0d2e340 · 0d2e340
1 parent 1e9da50
commit 0d2e340
Show file tree

Hide file tree

Showing 18 changed files with 441 additions and 191 deletions.
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/api/JavadocTokenTypes.java b/src/main/java/com/puppycrawl/tools/checkstyle/api/JavadocTokenTypes.java
@@ -313,7 +313,7 @@ public final class JavadocTokenTypes {
      *       |--SEE_LITERAL[3x0] : [@see]
      *       |--WS[3x4] : [ ]
      *       |--REFERENCE[3x5] : [org.apache.utils.Lists.Comparator#compare(Object)]
-     *           |--PACKAGE[3x5] : [org.apache.utils]
+     *           |--PACKAGE_CLASS[3x5] : [org.apache.utils]
      *           |--DOT[3x21] : [.]
      *           |--CLASS[3x22] : [Lists]
      *           |--DOT[3x27] : [.]
@@ -614,7 +614,7 @@ public final class JavadocTokenTypes {
      *        |--LINK_LITERAL[1x1] : [@link]
      *        |--WS[1x6] : [ ]
      *        |--REFERENCE[1x7] : [org.apache.utils.Lists.Comparator#compare(Object)]
-     *            |--PACKAGE[1x7] : [org.apache.utils]
+     *            |--PACKAGE_CLASS[1x7] : [org.apache.utils]
      *            |--DOT[1x23] : [.]
      *            |--CLASS[1x24] : [Lists]
      *            |--DOT[1x29] : [.]
@@ -680,7 +680,7 @@ public final class JavadocTokenTypes {
      *        |--LINKPLAIN_LITERAL[1x1] : [@linkplain]
      *        |--WS[1x11] : [ ]
      *        |--REFERENCE[1x12] : [org.apache.utils.Lists.Comparator#compare(Object)]
-     *            |--PACKAGE[1x12] : [org.apache.utils]
+     *            |--PACKAGE_CLASS[1x12] : [org.apache.utils]
      *            |--DOT[1x28] : [.]
      *            |--CLASS[1x29] : [Lists]
      *            |--DOT[1x34] : [.]
@@ -781,8 +781,7 @@ public final class JavadocTokenTypes {
     public static final int REFERENCE = JavadocParser.RULE_reference + RULE_TYPES_OFFSET;
 
     /**
-     * Package definition in {@link #REFERENCE}.
-     * Package definition is lowercase part of REFERENCE and before a hash character (#).
+     * Package_Class definition in {@link #REFERENCE}.
      *
      * <p>
      * <b>Example:</b>
@@ -793,7 +792,7 @@ public final class JavadocTokenTypes {
      *        |--SEE_LITERAL[3x0] : [@see]
      *        |--WS[3x4] : [ ]
      *        |--REFERENCE[3x5] : [org.apache.utils.Lists.Comparator#compare(Object)]
-     *            |--PACKAGE[3x5] : [org.apache.utils]
+     *            |--PACKAGE_CLASS[3x5] : [org.apache.utils]
      *            |--DOT[3x21] : [.]
      *            |--CLASS[3x22] : [Lists]
      *            |--DOT[3x27] : [.]
@@ -807,7 +806,7 @@ public final class JavadocTokenTypes {
      * }
      * </pre>
      */
-    public static final int PACKAGE = JavadocParser.PACKAGE;
+    public static final int PACKAGE_CLASS = JavadocParser.PACKAGE_CLASS;
 
     /**
      * Class definition in {@link #REFERENCE}.
@@ -823,7 +822,7 @@ public final class JavadocTokenTypes {
      *        |--SEE_LITERAL[3x0] : [@see]
      *        |--WS[3x4] : [ ]
      *        |--REFERENCE[3x5] : [org.apache.utils.Lists.Comparator#compare(Object)]
-     *            |--PACKAGE[3x5] : [org.apache.utils]
+     *            |--PACKAGE_CLASS[3x5] : [org.apache.utils]
      *            |--DOT[3x21] : [.]
      *            |--CLASS[3x22] : [Lists]
      *            |--DOT[3x27] : [.]
@@ -841,7 +840,7 @@ public final class JavadocTokenTypes {
 
     /**
      * Dot separator in {@link #REFERENCE}.
-     * Dot separator is used between {@link #PACKAGE} and {@link #CLASS}; between {@link #CLASS}
+     * Dot separator is used between {@link #PACKAGE_CLASS} and {@link #CLASS}; between {@link #CLASS}
      * and {@link #CLASS}
      *
      * <p>
@@ -853,7 +852,7 @@ public final class JavadocTokenTypes {
      *        |--SEE_LITERAL[3x0] : [@see]
      *        |--WS[3x4] : [ ]
      *        |--REFERENCE[3x5] : [org.apache.utils.Lists.Comparator#compare(Object)]
-     *            |--PACKAGE[3x5] : [org.apache.utils]
+     *            |--PACKAGE_CLASS[3x5] : [org.apache.utils]
      *            |--DOT[3x21] : [.]
      *            |--CLASS[3x22] : [Lists]
      *            |--DOT[3x27] : [.]
@@ -882,7 +881,7 @@ public final class JavadocTokenTypes {
      *        |--SEE_LITERAL[3x0] : [@see]
      *        |--WS[3x4] : [ ]
      *        |--REFERENCE[3x5] : [org.apache.utils.Lists.Comparator#compare(Object)]
-     *            |--PACKAGE[3x5] : [org.apache.utils]
+     *            |--PACKAGE_CLASS[3x5] : [org.apache.utils]
      *            |--DOT[3x21] : [.]
      *            |--CLASS[3x22] : [Lists]
      *            |--DOT[3x27] : [.]
@@ -911,7 +910,7 @@ public final class JavadocTokenTypes {
      *        |--SEE_LITERAL[3x0] : [@see]
      *        |--WS[3x4] : [ ]
      *        |--REFERENCE[3x5] : [org.apache.utils.Lists.Comparator#compare(Object)]
-     *            |--PACKAGE[3x5] : [org.apache.utils]
+     *            |--PACKAGE_CLASS[3x5] : [org.apache.utils]
      *            |--DOT[3x21] : [.]
      *            |--CLASS[3x22] : [Lists]
      *            |--DOT[3x27] : [.]

diff --git a/src/main/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/JavadocLexer.g4 b/src/main/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/JavadocLexer.g4
@@ -120,10 +120,10 @@ Newline5: NEWLINE
 Leading_asterisk3: LEADING_ASTERISK -> type(LEADING_ASTERISK);
 XmlTagOpen1: '<' -> type(OPEN), pushMode(xmlTagDefinition);
 STRING: '"' .*? '"' {referenceCatched = false;} -> mode(DEFAULT_MODE);
-PACKAGE: [a-z_$] ([a-z0-9_$] | '.')+ [a-z0-9_$] {referenceCatched = true;};
+PACKAGE_CLASS: [a-zA-Z_$] ('.'? [a-zA-Z0-9_$]+)* {referenceCatched = true;};
 DOT: '.';
 HASH: '#' {referenceCatched = true;} -> mode(classMemeber);
-CLASS: [A-Z] [a-zA-Z0-9_$]* {referenceCatched = true;};
+CLASS: [a-zA-Z_$] [a-zA-Z0-9_$]* {referenceCatched = true;};
 End20: JAVADOC_INLINE_TAG_END
       {
             insideJavadocInlineTag--;
@@ -252,7 +252,7 @@ Char8: .
 mode value;
 Space6: WS -> type(WS);
 Newline4: NEWLINE -> type(NEWLINE);
-Package2: PACKAGE -> type(PACKAGE);
+Package_Class2: PACKAGE_CLASS -> type(PACKAGE_CLASS);
 Dot2: DOT -> type(DOT);
 Class2: CLASS -> type(CLASS);
 Hash2: HASH -> type(HASH), mode(classMemeber);

diff --git a/src/main/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/JavadocParser.g4 b/src/main/resources/com/puppycrawl/tools/checkstyle/grammars/javadoc/JavadocParser.g4
@@ -861,8 +861,7 @@ description: (
 
 reference:
       (
-            PACKAGE (DOT | CLASS)* HASH? MEMBER? parameters?
-            | (DOT | CLASS)+ HASH? MEMBER? parameters?
+            PACKAGE_CLASS HASH? MEMBER? parameters?
             | HASH? MEMBER parameters?
       )
       ;

diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/grammars/javadoc/JavadocParseTreeTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/grammars/javadoc/JavadocParseTreeTest.java
@@ -250,4 +250,10 @@ public void testJavadocWithCrAsNewline() throws Exception {
         verifyJavadocTree(getPath("expectedJavadocWithCrAsNewlineAst.txt"),
                 getPath("InputJavadocWithCrAsNewline.javadoc"));
     }
+
+    @Test
+    public void testUppercaseInPackageName() throws Exception {
+        verifyJavadocTree(getDocPath("expectedUppercaseInPackageNameAst.txt"),
+                getDocPath("InputUppercaseInPackageName.javadoc"));
+    }
 }
diff --git a/...test/resources/com/puppycrawl/tools/checkstyle/astprinter/expectedInputJavadocComment.txt b/...test/resources/com/puppycrawl/tools/checkstyle/astprinter/expectedInputJavadocComment.txt
@@ -24,5 +24,5 @@ JAVADOC -> JAVADOC [0:0]
 |   |--SEE_LITERAL -> @see [3:0]
 |   |--WS ->   [3:4]
 |   `--REFERENCE -> REFERENCE [3:5]
-|       `--PACKAGE -> never [3:5]
+|       `--PACKAGE_CLASS -> never [3:5]
 `--EOF -> <EOF> [3:10]
diff --git a/...rces/com/puppycrawl/tools/checkstyle/astprinter/expectedNoUnnecessaryTextInJavadocAst.txt b/...rces/com/puppycrawl/tools/checkstyle/astprinter/expectedNoUnnecessaryTextInJavadocAst.txt
@@ -31,5 +31,5 @@ JAVADOC -> JAVADOC [0:0]
 |   |--SEE_LITERAL -> @see [3:2]
 |   |--WS ->   [3:6]
 |   `--REFERENCE -> REFERENCE [3:7]
-|       `--PACKAGE -> something [3:7]
+|       `--PACKAGE_CLASS -> something [3:7]
 `--EOF -> <EOF> [3:16]
diff --git a/...pycrawl/tools/checkstyle/grammars/javadoc/javadocTags/InputUppercaseInPackageName.javadoc b/...pycrawl/tools/checkstyle/grammars/javadoc/javadocTags/InputUppercaseInPackageName.javadoc
@@ -0,0 +1,22 @@
+* @see #fn
+* @see #FN
+* @see #C(Type)
+* @see #CN(Type id)
+* @see #mN(Type id, Type, Type id)
+* @see CN#fieldName
+* @see CN#fn
+* @see name#FN
+* @see CN#C(Type)
+* @see CN#CN(Type id)
+* @see CN#mN(Type id, Type, Type id)
+* @see lowercase.UPPERCASE.CamelCase.packageName.ClassName#fieldName
+* @see lowercase.UPPERCASE.CamelCase.packageName.ClassName#fn
+* @see lowercase.UPPERCASE.CamelCase.packageName.ClassName#FN
+* @see lowercase.UPPERCASE.CamelCase.packageName.ClassName#C(Type)
+* @see lowercase.UPPERCASE.CamelCase.packageName.ClassName#CN(Type id)
+* @see pn.CN#mN(Type id, Type, Type id)
+* @see pn.CN#FN
+* @see pn.CN#m
+* @see lowercase.UPPERCASE.CamelCase.packageName
+* @see pn.p
+* @see pn
diff --git a/...pycrawl/tools/checkstyle/grammars/javadoc/javadocTags/expectedAllJavadocInlineTagsAst.txt b/...pycrawl/tools/checkstyle/grammars/javadoc/javadocTags/expectedAllJavadocInlineTagsAst.txt
@@ -28,7 +28,7 @@ JAVADOC -> JAVADOC [0:0]
 |   |--LINK_LITERAL -> @link [0:64]
 |   |--WS ->   [0:69]
 |   |--REFERENCE -> REFERENCE [0:70]
-|   |   `--CLASS -> A [0:70]
+|   |   `--PACKAGE_CLASS -> A [0:70]
 |   |--DESCRIPTION -> DESCRIPTION [0:71]
 |   |   `--TEXT ->  A class [0:71]
 |   `--JAVADOC_INLINE_TAG_END -> } [0:79]
@@ -38,7 +38,7 @@ JAVADOC -> JAVADOC [0:0]
 |   |--LINKPLAIN_LITERAL -> @linkplain [0:82]
 |   |--WS ->   [0:92]
 |   |--REFERENCE -> REFERENCE [0:93]
-|   |   `--CLASS -> A [0:93]
+|   |   `--PACKAGE_CLASS -> A [0:93]
 |   |--DESCRIPTION -> DESCRIPTION [0:94]
 |   |   `--TEXT ->  another link [0:94]
 |   `--JAVADOC_INLINE_TAG_END -> } [0:107]
@@ -48,9 +48,7 @@ JAVADOC -> JAVADOC [0:0]
 |   |--VALUE_LITERAL -> @value [0:110]
 |   |--WS ->   [0:116]
 |   |--REFERENCE -> REFERENCE [0:117]
-|   |   |--PACKAGE -> lang [0:117]
-|   |   |--DOT -> . [0:121]
-|   |   |--CLASS -> Integer [0:122]
+|   |   |--PACKAGE_CLASS -> lang.Integer [0:117]
 |   |   |--HASH -> # [0:129]
 |   |   `--MEMBER -> MAX_VALUE [0:130]
 |   `--JAVADOC_INLINE_TAG_END -> } [0:139]