From ef51223aa342db256c12a65526fda69f1628ed01 Mon Sep 17 00:00:00 2001 From: Jan Lahoda Date: Mon, 16 May 2016 15:41:20 +0200 Subject: [PATCH] 8054562: document skip results in RunCodingRules.java Documenting when RunCodingRules gets skipped; adding a short description of AssertCheckAnalyzer and MutableFieldsAnalyzer Reviewed-by: jjg --- langtools/make/tools/crules/AssertCheckAnalyzer.java | 3 +++ .../make/tools/crules/MutableFieldsAnalyzer.java | 1 + langtools/test/tools/all/RunCodingRules.java | 11 +++++++++++ 3 files changed, 15 insertions(+) diff --git a/langtools/make/tools/crules/AssertCheckAnalyzer.java b/langtools/make/tools/crules/AssertCheckAnalyzer.java index d46b5e13d65..b665d74215e 100644 --- a/langtools/make/tools/crules/AssertCheckAnalyzer.java +++ b/langtools/make/tools/crules/AssertCheckAnalyzer.java @@ -37,6 +37,9 @@ import com.sun.tools.javac.tree.TreeInfo; import com.sun.tools.javac.tree.TreeScanner; import com.sun.tools.javac.util.Assert; +/**This analyzer guards against complex messages (i.e. those that use string concatenation) passed + * to various Assert.check methods. + */ public class AssertCheckAnalyzer extends AbstractCodingRulesAnalyzer { enum AssertOverloadKind { diff --git a/langtools/make/tools/crules/MutableFieldsAnalyzer.java b/langtools/make/tools/crules/MutableFieldsAnalyzer.java index a992f55884b..defb98760a1 100644 --- a/langtools/make/tools/crules/MutableFieldsAnalyzer.java +++ b/langtools/make/tools/crules/MutableFieldsAnalyzer.java @@ -41,6 +41,7 @@ import static com.sun.tools.javac.code.Flags.STATIC; import static com.sun.tools.javac.code.Flags.SYNTHETIC; import static com.sun.tools.javac.code.Kinds.Kind.*; +/**This analyzer guards against non-final static fields.*/ public class MutableFieldsAnalyzer extends AbstractCodingRulesAnalyzer { public MutableFieldsAnalyzer(JavacTask task) { diff --git a/langtools/test/tools/all/RunCodingRules.java b/langtools/test/tools/all/RunCodingRules.java index 4e3d5db7f33..8e345ce1b5e 100644 --- a/langtools/test/tools/all/RunCodingRules.java +++ b/langtools/test/tools/all/RunCodingRules.java @@ -50,6 +50,17 @@ import javax.tools.ToolProvider; import com.sun.tools.javac.util.Assert; +/** + * This is a test to verify specific coding standards for source code in the langtools repository. + * + * As such, it is not a standard unit, regression or functional test, and will + * automatically skip if the langtools source code is not available. + * + * If the source code is available, it will find and compile the coding + * style analyzers found in langtools/make/tools/crules/*.java, and run the resulting + * code on all source files under langtools/src/share/classes. Any coding style + * violations will cause the test to fail. + */ public class RunCodingRules { public static void main(String... args) throws Exception { new RunCodingRules().run();