Issue checkstyle#3888: update google java style coverage to 20170228 …

…state
SergeyDzyuba · Mar 22, 2017 · bbfb252 · bbfb252
1 parent ab0dd01
commit bbfb252
Show file tree

Hide file tree

Showing 8 changed files with 106 additions and 92 deletions.
diff --git a/...ain/java/com/puppycrawl/tools/checkstyle/checks/indentation/CommentsIndentationCheck.java b/...ain/java/com/puppycrawl/tools/checkstyle/checks/indentation/CommentsIndentationCheck.java
@@ -33,7 +33,7 @@
  * Comments are indented at the same level as the surrounding code.
  * Detailed info about such convention can be found
  * <a href=
- * "http://checkstyle.sourceforge.net/reports/google-java-style.html#s4.8.6.1-block-comment-style">
+ * "http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.8.6.1-block-comment-style">
  * here</a>
  * <p>
  * Examples:

diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/AtclauseOrderCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/AtclauseOrderCheck.java
@@ -32,7 +32,12 @@
 
 /**
  * <p>
- * Checks the order of at-clauses.
+ * Checks the order of
+ * <a href="http://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDBEFIF">
+ * javadoc block-tags or javadoc tags</a>.
+ * </p>
+ * <p>
+ * Note: Google used term "at-clauses" for block tags in his guide till 2017-02-28.
  * </p>
  *
  * <p>

diff --git a/...ain/java/com/puppycrawl/tools/checkstyle/checks/naming/AbbreviationAsWordInNameCheck.java b/...ain/java/com/puppycrawl/tools/checkstyle/checks/naming/AbbreviationAsWordInNameCheck.java
@@ -36,7 +36,8 @@
  * <p>
  * The Check validate abbreviations(consecutive capital letters) length in
  * identifier name, it also allows to enforce camel case naming. Please read more at
- * <a href="http://checkstyle.sourceforge.net/reports/google-java-style.html#s5.3-camel-case">
+ * <a href=
+ *  "http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s5.3-camel-case">
  * Google Style Guide</a> to get to know how to avoid long abbreviations in names.
  * </p>
  * <p>

diff --git a/src/xdocs/config_javadoc.xml b/src/xdocs/config_javadoc.xml
@@ -24,7 +24,9 @@
     <section name="AtclauseOrder">
       <subsection name="Description">
         <p>
-          Checks the order of at-clauses.
+          Checks the order of <a href="http://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDBEFIF">javadoc block-tags or javadoc tags</a>.
+          <br/>
+          Note: Google used term "at-clauses" for block tags in his guide till 2017-02-28.
         </p>
       </subsection>
 

diff --git a/src/xdocs/config_misc.xml b/src/xdocs/config_misc.xml
@@ -272,7 +272,7 @@ String unitAbbrev = "\u03bc\u03bc\u03bc";
           Controls the indentation between comments and surrounding code.
           Comments are indented at the same level as the surrounding code.
           Detailed info about such convention can be found <a href=
-          "http://checkstyle.sourceforge.net/reports/google-java-style.html#s4.8.6.1-block-comment-style">
+          "http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.8.6.1-block-comment-style">
           here</a>
         </p>
         <p>Please take a look at the following examples to understand how the check works:</p>

diff --git a/src/xdocs/config_naming.xml b/src/xdocs/config_naming.xml
@@ -36,7 +36,7 @@
         <p>
          The Check validate abbreviations(consecutive capital letters)
          length in identifier name, it also allows to enforce camel case naming. Please read more at
-         <a href="http://checkstyle.sourceforge.net/reports/google-java-style.html#s5.3-camel-case">
+         <a href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s5.3-camel-case">
          Google Style Guide</a>
          to get to know how to avoid long abbreviations in names.
         </p>

diff --git a/src/xdocs/google_style.xml b/src/xdocs/google_style.xml
diff --git a/src/xdocs/index.xml.vm b/src/xdocs/index.xml.vm
@@ -29,7 +29,7 @@
         any coding standard. An example configuration files are supplied
         supporting the <a href="http://www.oracle.com/technetwork/java/javase/documentation/codeconvtoc-136057.html">
         Sun Code Conventions</a>,
-        <a href="http://checkstyle.sourceforge.net/reports/google-java-style.html">Google Java Style</a>.
+        <a href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html">Google Java Style</a>.
       </p>
 
       <p>