From 209654f19e69932fcc35fade290b878f85f30d81 Mon Sep 17 00:00:00 2001 From: Reinier Zwitserloot Date: Mon, 2 Feb 2015 00:17:51 +0100 Subject: [i702] findbugs suppress warnings now available via config key. --- website/features/configuration.html | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) (limited to 'website') diff --git a/website/features/configuration.html b/website/features/configuration.html index 1f31fe01..7e79a9c0 100644 --- a/website/features/configuration.html +++ b/website/features/configuration.html @@ -21,7 +21,9 @@ Usually, a user of lombok puts a lombok.config file with their preferences in a workspace or project root directory, with the special config.stopBubbling = true key to tell lombok this is your root directory. You can then create lombok.config files in any subdirectories (generally representing projects or source packages) with different settings.

An up to date list of all configuration keys supported by your version of lombok can be generated by running: -

java -jar lombok.jar config -g --verbose
+
+ java -jar lombok.jar config -g --verbose +
The output of the config tool is itself a valid lombok.config file.
The config tool can also be used to display the complete lombok configuration used for any given directory or source file by supplying these as arguments.

@@ -42,7 +44,7 @@ Configuration files are hierarchical: Any configuration setting applies to all source files in that directory, and all source files in subdirectories, but configuration settings closer to the source file take precedence. For example, if you have in /Users/me/projects/lombok.config the following:

lombok.log.fieldName = foobar -
+ and in /Users/me/projects/MyProject/lombok.config you have:
lombok.log.fieldName = xyzzy @@ -61,14 +63,27 @@ lombok.accessors.prefix += m_

+ Comments can be included in lombok.config files; any line that starts with # is considered a comment. +

+ +
+

Global config keys

+

To stop lombok from looking at parent directories for more configuration files, the special key:

config.stopBubbling = true
- can be included. + can be included. We suggest you put this in the root of your workspace directory.

- Comments can be included in lombok.config files; any line that starts with # is considered a comment. -

+ Lombok normally adds @javax.annotation.Generated annotations to all generated nodes where possible. You can stop this with: +
+ lombok.addGeneratedAnnotation = false +
+

+ Lombok can add the @SuppressFBWarnings annotation which is useful if you want to run FindBugs on your class files. To enable this feature, make sure findbugs is on the classpath when you compile, and add the following config key: +

+ lombok.extern.findbugs.addSuppressFBWarnings = true +
-- cgit