summaryrefslogtreecommitdiff
path: root/doc/ale-kotlin.txt
diff options
context:
space:
mode:
authorFrancis Agyapong <francisagyapong2@gmail.com>2017-05-02 11:27:04 -0600
committerw0rp <w0rp@users.noreply.github.com>2017-05-02 18:27:04 +0100
commit36314aeaf2c1c5e272d7f3e5d696b5fc348081fd (patch)
treebe3b130b14c446c6ce6ca09696a6f64aa35a38e7 /doc/ale-kotlin.txt
parentd5c135cfaff0568717ec9e4e0dab5d37e8a12921 (diff)
downloadale-36314aeaf2c1c5e272d7f3e5d696b5fc348081fd.zip
Add kotlinc checker for kotlin (#526)
* Add kotlinc checker for kotlin
Diffstat (limited to 'doc/ale-kotlin.txt')
-rw-r--r--doc/ale-kotlin.txt65
1 files changed, 65 insertions, 0 deletions
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: