config/.vim/eclim/doc/vim/java/checkstyle.txt

54 lines
1.3 KiB
Plaintext

*vim-java-checkstyle*
Checkstyle
**********
*:Checkstyle*
When editing a java source file, eclim provides the command
:Checkstyle which will invoke checkstyle
(http://checkstyle.sourceforge.net/) on the current file.
Additionally, you can configure vim to execute checkstyle
automatically when you save a java source file. Simply set the vim
variable g:EclimJavaCheckstyleOnSave to 1 in your vimrc or java
ftplugin.
>
let g:EclimJavaCheckstyleOnSave = 1
<
Please note that both methods of invoking checkstyle require that you
first configure the location of your checkstyle config file using the
eclim setting org.eclim.java.checkstyle.config, described in the
configuration section below.
Configuration
=============
Vim Settings
*g:EclimJavaCheckstyleOnSave*
- g:EclimJavaCheckstyleOnSave (Default: 0) - When non-zero, enables
running of checkstyle automatially upon saving of a java source
file.
Eclim Settings
*org.eclim.java.checkstyle.config*
- org.eclim.java.checkstyle.config - Defines the location (project
relative or absolute) or your checkstyle config file.
*org.eclim.java.checkstyle.properties*
- org.eclim.java.checkstyle.properties - Defines the location (project
relative or absolute) or your checkstyle properties file.
vim:ft=eclimhelp