#2542 - Improve checkstyle project configuration

1 files changed, 34 insertions, 7 deletions

diff --git a/doc/ale-java.txt b/doc/ale-java.txt
index 4a71d9ef..65d2299b 100644
--- a/doc/ale-java.txt
+++ b/doc/ale-java.txt
@@ -5,14 +5,41 @@ ALE Java Integration                                         *ale-java-options*
 ===============================================================================
 checkstyle                                                *ale-java-checkstyle*
 
+g:ale_java_checkstyle_config                     *g:ale_java_checkstyle_config*
+                                                 *b:ale_java_checkstyle_config*
+
+  Type: |String|
+  Default: `'google_checks.xml'`
+
+  A path to a checkstyle configuration file.
+
+  If a configuration file is specified with |g:ale_java_checkstyle_options|,
+  it will be preferred over this setting.
+
+  The path to the configuration file can be an absolute path or a relative
+  path. ALE will search for the relative path in parent directories.
+
+
+g:ale_java_checkstyle_executable             *g:ale_java_checkstyle_executable*
+                                             *b:ale_java_checkstyle_executable*
+
+  Type: |String|
+  Default: 'checkstyle'
+
+  This variable can be changed to modify the executable used for checkstyle.
+
+
 g:ale_java_checkstyle_options                   *g:ale_java_checkstyle_options*
                                                 *b:ale_java_checkstyle_options*
 
-  Type: String
-  Default: '-c /google_checks.xml'
+  Type: |String|
+  Default: `''`
 
   This variable can be changed to modify flags given to checkstyle.
 
+  If a configuration file is specified with `-c`, it will be used instead of
+  configuration files set with |g:ale_java_checkstyle_config|.
+
 
 ===============================================================================
 javac                                                          *ale-java-javac*
@@ -118,7 +145,7 @@ located inside the repository folder `eclipse.jdt.ls`. Please ensure to set
 |g:ale_java_eclipselsp_path| to the absolute path of that folder.
 
 You could customize compiler options and code assists of the server.
-Under your project folder, modify the file `.settings/org.eclipse.jdt.core.prefs` 
+Under your project folder, modify the file `.settings/org.eclipse.jdt.core.prefs`
 with options presented at
 https://help.eclipse.org/neon/topic/org.eclipse.jdt.doc.isv/reference/api/org/eclipse/jdt/core/JavaCore.html.
 
@@ -141,8 +168,8 @@ g:ale_java_eclipselsp_executable                *g:ale_java_eclipse_executable*
   This variable can be set to change the executable path used for java.
 
 
-g:ale_java_eclipselsp_config_path                *g:ale_java_eclipse_config_path*
-                                                 *b:ale_java_eclipse_config_path*
+g:ale_java_eclipselsp_config_path              *g:ale_java_eclipse_config_path*
+                                               *b:ale_java_eclipse_config_path*
   Type: |String|
   Default: `''`
 
@@ -155,8 +182,8 @@ g:ale_java_eclipselsp_config_path                *g:ale_java_eclipse_config_path
   installed via system package.
 
 
-g:ale_java_eclipselsp_workspace_path       *g:ale_java_eclipselsp_workspace_path*
-                                           *b:ale_java_eclipselsp_workspace_path*
+g:ale_java_eclipselsp_workspace_path     *g:ale_java_eclipselsp_workspace_path*
+                                         *b:ale_java_eclipselsp_workspace_path*
 
   Type: |String|
   Default: `''`