diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/indentation/CommentsIndentationCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/indentation/CommentsIndentationCheck.java
index 012dbca46693..fb88ec8791af 100644
--- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/indentation/CommentsIndentationCheck.java
+++ b/src/main/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
*
+ * "http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.8.6.1-block-comment-style">
* here
*
* 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
index 6a71b2810efc..db7044a1ed57 100644
--- 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 @@
/**
*
- * Checks the order of at-clauses.
+ * Checks the order of
+ *
+ * javadoc block-tags or javadoc tags.
+ *
+ *
+ * Note: Google used term "at-clauses" for block tags in his guide till 2017-02-28.
*
*
*
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/AbbreviationAsWordInNameCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/AbbreviationAsWordInNameCheck.java
index 501d2282afdf..53e3417ae205 100644
--- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/AbbreviationAsWordInNameCheck.java
+++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/AbbreviationAsWordInNameCheck.java
@@ -36,7 +36,8 @@
*
* The Check validate abbreviations(consecutive capital letters) length in
* identifier name, it also allows to enforce camel case naming. Please read more at
- *
+ *
* Google Style Guide to get to know how to avoid long abbreviations in names.
*
*
diff --git a/src/xdocs/config_javadoc.xml b/src/xdocs/config_javadoc.xml
index 26d536b40669..df11670a3d7f 100644
--- a/src/xdocs/config_javadoc.xml
+++ b/src/xdocs/config_javadoc.xml
@@ -24,7 +24,9 @@
Please take a look at the following examples to understand how the check works:
diff --git a/src/xdocs/config_naming.xml b/src/xdocs/config_naming.xml
index ed3e8ddae33f..bb27871cf403 100644
--- a/src/xdocs/config_naming.xml
+++ b/src/xdocs/config_naming.xml
@@ -36,7 +36,7 @@
The Check validate abbreviations(consecutive capital letters)
length in identifier name, it also allows to enforce camel case naming. Please read more at
-
+
Google Style Guide
to get to know how to avoid long abbreviations in names.
diff --git a/src/xdocs/google_style.xml b/src/xdocs/google_style.xml
index d3bdfabe1449..2f050d30a846 100644
--- a/src/xdocs/google_style.xml
+++ b/src/xdocs/google_style.xml
@@ -19,8 +19,8 @@
This coverage report was created for
Google Java Style
- (cached page)
- , version of 17 November 2016
+ (cached page)
+ , version of 28 February 2017
@@ -70,7 +70,7 @@
|
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s1-introduction">
1 Introduction
|
@@ -81,7 +81,7 @@
|
1.1 Terminology notes
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s1.1-terminology">1.1 Terminology notes
|
-- |
|
@@ -90,7 +90,7 @@
|
1.2 Guide notes
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s1.2-guide-notes">1.2 Guide notes
|
-- |
@@ -100,7 +100,7 @@
| |
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s2-source-file-basics">
2 Source file basics
|
@@ -111,7 +111,7 @@
|
2.1 File name
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s2.1-file-name">2.1 File name
|
|
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s2.2-file-encoding">
2.2 File encoding: UTF-8
|
@@ -148,7 +148,7 @@
|
2.3.1 Whitespace characters
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s2.3.1-whitespace-characters">2.3.1 Whitespace characters
|
|
2.3.2 Special escape sequences
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s2.3.2-special-escape-sequences">2.3.2 Special escape sequences
|
|
2.3.3 Non-ASCII characters
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s2.3.3-non-ascii-characters">2.3.3 Non-ASCII characters
|
|
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s3-source-file-structure">
3 Source file structure
|
@@ -231,7 +231,7 @@
|
3.1 License or copyright information, if present
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s3.1-copyright-statement">3.1 License or copyright information, if present
|
-- |
|
@@ -240,7 +240,7 @@
|
3.2 Package statement
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s3.2-package-statement">3.2 Package statement
|
|
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s3.3-import-statements">
3.3 Import statements
|
@@ -284,7 +284,7 @@
|
3.3.1 No wildcard imports
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s3.3.1-wildcard-imports">3.3.1 No wildcard imports
|
|
3.3.2 No line-wrapping
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s3.3.2-import-line-wrapping">3.3.2 No line-wrapping
|
|
3.3.3 Ordering and spacing
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s3.3.3-import-ordering-and-spacing">3.3.3 Ordering and spacing
|
|
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s3.3.4-import-class-not-static">
3.3.4 No static import for classes
|
@@ -376,7 +376,7 @@
| |
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s3.4-class-declaration">
3.4 Class declaration
|
@@ -387,7 +387,7 @@
|
3.4.1 Exactly one top-level class declaration
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s3.4.1-one-top-level-class">3.4.1 Exactly one top-level class declaration
|
|
3.4.2 Class member ordering
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s3.4.2-class-member-ordering">3.4.2 Class member ordering
|
-- |
|
@@ -416,7 +416,7 @@
|
3.4.2.1 Overloads: never split
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s3.4.2.1-overloads-never-split">3.4.2.1 Overloads: never split
|
|
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4-formatting">
4 Formatting
|
@@ -447,7 +447,7 @@
|
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.1-braces">
4.1 Braces
|
@@ -458,7 +458,7 @@
|
4.1.1 Braces are used where optional
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.1.1-braces-always-used">4.1.1 Braces are used where optional
|
|
4.1.2 Nonempty blocks: K & R style
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.1.2-blocks-k-r-style">4.1.2 Nonempty blocks: K & R style
|
|
4.1.3 Empty blocks: may be concise
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.1.3-braces-empty-blocks">4.1.3 Empty blocks: may be concise
|
|
4.2 Block indentation: +2 spaces
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.2-block-indentation">4.2 Block indentation: +2 spaces
|
|
4.3 One statement per line
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.3-one-statement-per-line">4.3 One statement per line
|
|
4.4 Column limit: 100
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.4-column-limit">4.4 Column limit: 100
|
|
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.5-line-wrapping">
4.5 Line-wrapping
|
@@ -624,7 +624,7 @@
|
4.5.1 Where to break
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.5.1-line-wrapping-where-to-break">4.5.1 Where to break
|
|
4.5.2 Indent continuation lines at least +4 spaces
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.5.2-line-wrapping-indent">4.5.2 Indent continuation lines at least +4 spaces
|
|
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.6-whitespace">
4.6 Whitespace
|
@@ -699,7 +699,7 @@
|
4.6.1 Vertical Whitespace
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.6.1-vertical-whitespace">4.6.1 Vertical Whitespace
|
|
4.6.2 Horizontal whitespace
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.6.2-horizontal-whitespace">4.6.2 Horizontal whitespace
|
|
4.6.3 Horizontal alignment: never required
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.6.3-horizontal-alignment">4.6.3 Horizontal alignment: never required
|
-- |
|
@@ -789,7 +789,7 @@
|
4.7 Grouping parentheses: recommended
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.7-grouping-parentheses">4.7 Grouping parentheses: recommended
|
-- |
|
@@ -798,7 +798,7 @@
|
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.8-specific-constructs">
4.8 Specific constructs
|
@@ -809,7 +809,7 @@
|
4.8.1 Enum classes
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.8.1-enum-classes">4.8.1 Enum classes
|
-- |
|
@@ -818,7 +818,7 @@
|
4.8.2 Variable declarations
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.8.2-variable-declarations">4.8.2 Variable declarations
|
↓ |
|
@@ -827,7 +827,7 @@
|
4.8.2.1 One variable per declaration
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.8.2.1-variables-per-declaration">4.8.2.1 One variable per declaration
|
|
4.8.2.2 Declared when needed
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.8.2.2-variables-limited-scope">4.8.2.2 Declared when needed
|
@@ -870,7 +870,7 @@
| |
4.8.3 Arrays
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.8.3-arrays">4.8.3 Arrays
|
↓ |
|
@@ -879,7 +879,7 @@
|
4.8.3.1 Array initializers: can be "block-like"
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.8.3.1-array-initializers">4.8.3.1 Array initializers: can be "block-like"
|
-- |
|
@@ -888,7 +888,7 @@
|
4.8.3.2 No C-style array declarations
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.8.3.2-array-declarations">4.8.3.2 No C-style array declarations
|
|
4.8.4 Switch statements
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.8.4-switch">4.8.4 Switch statements
|
-- |
|
@@ -918,7 +918,7 @@
|
4.8.4.1 Indentation
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.8.4.1-switch-indentation">4.8.4.1 Indentation
|
|
4.8.4.2 Fall-through: commented
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.8.4.2-switch-fall-through">4.8.4.2 Fall-through: commented
|
|
4.8.4.3 The default case is present
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.8.4.3-switch-default">4.8.4.3 The default case is present
|
MissingSwitchDefault
+
+ "Exception: enum type may omit the default statement group" requirement can not be covered as we can not distinguish types,
+ enum values may look the same as static final String constants.
|
|
4.8.5 Annotations
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.8.5-annotations">4.8.5 Annotations
|
|
4.8.6 Comments
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.8.6-comments">4.8.6 Comments
|
↓ |
|
@@ -1009,7 +1012,7 @@
|
4.8.6.1 Block comment style
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.8.6.1-block-comment-style">4.8.6.1 Block comment style
|
|
4.8.7 Modifiers
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.8.7-modifiers">4.8.7 Modifiers
|
|
4.8.8 Numeric Literals
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s4.8.8-numeric-literals">4.8.8 Numeric Literals
|
|
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s5-naming">
5 Naming
|
@@ -1082,7 +1085,7 @@
|
5.1 Rules common to all identifiers
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s5.1-identifier-names">5.1 Rules common to all identifiers
|
"5.2 Rules of identifier type" already includes this rule.
|
@@ -1092,7 +1095,7 @@
|
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s5.2-specific-identifier-names">
5.2 Rules by identifier type
|
@@ -1103,7 +1106,7 @@
|
5.2.1 Package names
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s5.2.1-package-names">5.2.1 Package names
|
|
5.2.2 Class names
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s5.2.2-class-names">5.2.2 Class names
|
|
5.2.3 Method names
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s5.2.3-method-names">5.2.3 Method names
|
|
5.2.4 Constant names
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s5.2.4-constant-names">5.2.4 Constant names
|
|
5.2.5 Non-constant field names
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s5.2.5-non-constant-field-names">5.2.5 Non-constant field names
|
|
5.2.6 Parameter names
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s5.2.6-parameter-names">5.2.6 Parameter names
|
|
5.2.7 Local variable names
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s5.2.7-local-variable-names">5.2.7 Local variable names
|
|
5.2.8 Type variable names
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s5.2.8-type-variable-names">5.2.8 Type variable names
|
|
5.3 Camel case: defined
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s5.3-camel-case">5.3 Camel case: defined
|
|
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s6-programming-practices">
6 Programming Practices
|
@@ -1326,7 +1329,7 @@
|
6.1 @Override: always used
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s6.1-override-annotation">6.1 @Override: always used
|
|
6.2 Caught exceptions: not ignored
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s6.2-caught-exceptions">6.2 Caught exceptions: not ignored
|
|
6.3 Static members: qualified using class
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s6.3-static-members">6.3 Static members: qualified using class
|
|
6.4 Finalizers: not used
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s6.4-finalizers">6.4 Finalizers: not used
|
|
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s7-javadoc">
7 Javadoc
|
@@ -1410,7 +1413,7 @@
|
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s7.1-javadoc-formatting">
7.1 Formatting
|
@@ -1421,13 +1424,16 @@
|
7.1.1 General form
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s7.1.1-javadoc-multi-line">7.1.1 General form
|
+
SingleLineJavadoc
+ Recent update for guide that clarify requirements will be addressed at
+ #4052
|
|
7.1.2 Paragraphs
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s7.1.2-javadoc-paragraphs">7.1.2 Paragraphs
|
|
7.1.3 At-clauses
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s7.1.3-javadoc-at-clauses">7.1.3 Block tags
|
|
7.2 The summary fragment
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s7.2-summary-fragment">7.2 The summary fragment
|
|
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s7.3-javadoc-where-required">
7.3 Where Javadoc is used
|
@@ -1539,7 +1545,7 @@
|
7.3.1 Exception: self-explanatory methods
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s7.3.1-javadoc-exception-self-explanatory">7.3.1 Exception: self-explanatory methods
|
|
7.3.2 Exception: overrides
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s7.3.2-javadoc-exception-overrides">7.3.2 Exception: overrides
|
|
7.3.4 Non-required Javadoc
+ href="http://checkstyle.sourceforge.net/reports/google-java-style-20170228.html#s7.3.4-javadoc-non-required">7.3.4 Non-required Javadoc
|
-- |
|
diff --git a/src/xdocs/index.xml.vm b/src/xdocs/index.xml.vm
index 43ffebbd6aaf..3e7fdc7a3b55 100644
--- 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
Sun Code Conventions,
- Google Java Style.
+ Google Java Style.