summaryrefslogtreecommitdiff
path: root/doc/ale-cpp.txt
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2017-03-28 23:25:44 +0100
committerw0rp <devw0rp@gmail.com>2017-03-28 23:25:44 +0100
commitd7f8324c3c9b9eb6ea49591fc4fa37948996170d (patch)
tree8a342445f96fbbb904895babba106139c7dc22a2 /doc/ale-cpp.txt
parent094eeb267397acdc7eb35498f06088aec1eb339a (diff)
downloadale-d7f8324c3c9b9eb6ea49591fc4fa37948996170d.zip
Move linter documentation into separate files
Diffstat (limited to 'doc/ale-cpp.txt')
-rw-r--r--doc/ale-cpp.txt50
1 files changed, 50 insertions, 0 deletions
diff --git a/doc/ale-cpp.txt b/doc/ale-cpp.txt
new file mode 100644
index 00000000..efe7e080
--- /dev/null
+++ b/doc/ale-cpp.txt
@@ -0,0 +1,50 @@
+===============================================================================
+ALE C++ Integration *ale-cpp-options*
+
+
+-------------------------------------------------------------------------------
+clang *ale-cpp-clang*
+
+g:ale_cpp_clang_options *g:ale_cpp_clang_options*
+
+ Type: |String|
+ Default: `'-std=c++14 -Wall'`
+
+ This variable can be changed to modify flags given to clang.
+
+
+-------------------------------------------------------------------------------
+clangtidy *ale-cpp-clangtidy*
+
+g:ale_cpp_clangtidy_options *g:ale_cpp_clangtidy_options*
+
+ Type: |String|
+ Default: `'-std=c++14 -Wall'`
+
+ This variable can be changed to modify flags given to clangtidy.
+
+
+-------------------------------------------------------------------------------
+cppcheck *ale-cpp-cppcheck*
+
+g:ale_cpp_cppcheck_options *g:ale_cpp_cppcheck_options*
+
+ Type: |String|
+ Default: `'--enable=style'`
+
+ This variable can be changed to modify flags given to cppcheck.
+
+
+-------------------------------------------------------------------------------
+gcc *ale-cpp-gcc*
+
+g:ale_cpp_gcc_options *g:ale_cpp_gcc_options*
+
+ Type: |String|
+ Default: `'-std=c++14 -Wall'`
+
+ This variable can be changed to modify flags given to gcc.
+
+
+-------------------------------------------------------------------------------
+ vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: