Move linter documentation into separate files

2017-03-28 23:25:44 +01:00
parent 094eeb2673
commit d7f8324c3c
24 changed files with 919 additions and 721 deletions
--- a/doc/ale-cpp.txt
+++ 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: