From 36314aeaf2c1c5e272d7f3e5d696b5fc348081fd Mon Sep 17 00:00:00 2001
From: Francis Agyapong <francisagyapong2@gmail.com>
Date: Tue, 2 May 2017 11:27:04 -0600
Subject: Add kotlinc checker for kotlin (#526)

* Add kotlinc checker for kotlin
---
 doc/ale-kotlin.txt | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 65 insertions(+)
 create mode 100644 doc/ale-kotlin.txt

(limited to 'doc/ale-kotlin.txt')

diff --git a/doc/ale-kotlin.txt b/doc/ale-kotlin.txt
new file mode 100644
index 00000000..04efaeaf
--- /dev/null
+++ b/doc/ale-kotlin.txt
@@ -0,0 +1,65 @@
+===============================================================================
+ALE Kotlin Integration                                     *ale-kotlin-options*
+                                                       *ale-integration-kotlin*
+
+-------------------------------------------------------------------------------
+Integration Information
+
+  Make sure your setup has support for the kotlin file type. A filetype plugin
+  can be found here: https://github.com/udalov/kotlin-vim
+
+
+  Note: Make sure you have a working kotlin compiler
+
+
+-------------------------------------------------------------------------------
+kotlinc                                                    *ale-kotlin-kotlinc*
+
+g:ale_kotlin_kotlinc_options                     *g:ale_kotlin_kotlinc_options*
+  Type: |String|
+  Default: `''`
+
+  Additional options to pass to the kotlin compiler
+
+g:ale_kotlin_kotlinc_enable_config         *g:ale_kotlin_kotlinc_enable_config*
+  Type: |Number|
+  Default: `0`
+
+  Setting this variable to `1` tells the linter to load a configuration file.
+  This should be set in your vimrc
+
+g:ale_kotlin_kotlinc_config_file             *g:ale_kotlin_kotlinc_config_file*
+  Type: |String|
+  Default: `'.ale_kotlin_kotlinc_config'`
+
+  Filename of the configuration file. This should be set in your vimrc
+
+g:ale_kotlin_kotlinc_classpath                 *g:ale_kotlin_kotlinc_classpath*
+  Type: |String|
+  Default: `''`
+
+  A string containing the paths (separated by the appropriate path separator)
+  of the source directories.
+
+g:ale_kotlin_kotlinc_sourcepath               *g:ale_kotlin_kotlinc_sourcepath*
+  Type: |String|
+  Default: `''`
+
+  A string containing the paths (separated by space) of the source
+  directories.
+
+g:ale_kotlin_kotlinc_use_module_file     *g:ale_kotlin_kotlinc_use_module_file*
+  Type: |Number|
+  Default: `0`
+
+  This option indicates whether the linter should use a module file. It is off
+  by default.
+
+g:ale_kotlin_kotlinc_module_filename     *g:ale_kotlin_kotlinc_module_filename*
+  Type: |String|
+  Default: `'module.xml'`
+
+  The filename of the module file that the linter should pass to the kotlin
+  compiler.
+
+  vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
-- 
cgit v1.2.3