diff options
Diffstat (limited to 'website/features')
| -rw-r--r-- | website/features/configuration.html | 25 |
1 files changed, 20 insertions, 5 deletions
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 <code>lombok.config</code> file with their preferences in a workspace or project root directory, with the special <code>config.stopBubbling = true</code> key to tell lombok this is your root directory. You can then create <code>lombok.config</code> files in any subdirectories (generally representing projects or source packages) with different settings. </p><p> An up to date list of all configuration keys supported by your version of lombok can be generated by running: - <div class="snippet example"><code>java -jar lombok.jar config -g --verbose</code></div> + <div class="snippet example"> + <code>java -jar lombok.jar config -g --verbose</code> + </div> The output of the <em>config</em> tool is itself a valid <code>lombok.config</code> file.<br /> The <em>config</em> tool can also be used to display the complete lombok configuration used for any given directory or source file by supplying these as arguments. </p><p> @@ -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 <code>/Users/me/projects/lombok.config</code> the following: <div class="snippet example"> <code>lombok.log.fieldName = foobar</code> - </div></div> + </div> and in <code>/Users/me/projects/MyProject/lombok.config</code> you have: <div class="snippet example"> <code>lombok.log.fieldName = xyzzy</code> @@ -61,14 +63,27 @@ <code>lombok.accessors.prefix += m_</code> </div> </p><p> + Comments can be included in <code>lombok.config</code> files; any line that starts with <code>#</code> is considered a comment. + </p> + </div> + <div class="overview" style="clear: left;"> + <h3>Global config keys</h3> + <p> To stop lombok from looking at parent directories for more configuration files, the special key: <div class="snippet example"> <code>config.stopBubbling = true</code> </div> - can be included. + can be included. We suggest you put this in the root of your workspace directory. </p><p> - Comments can be included in <code>lombok.config</code> files; any line that starts with <code>#</code> is considered a comment. - </p> + Lombok normally adds <code>@javax.annotation.Generated</code> annotations to all generated nodes where possible. You can stop this with: + <div class="snippet example"> + <code>lombok.addGeneratedAnnotation = false</code> + </div> + </p><p> + Lombok can add the <code>@SuppressFBWarnings</code> annotation which is useful if you want to run <a href="http://findbugs.sourceforge.net/">FindBugs</a> on your class files. To enable this feature, make sure findbugs is on the classpath when you compile, and add the following config key: + <div class="snippet example"> + <code>lombok.extern.findbugs.addSuppressFBWarnings = true</code> + </div> </div> <div style="clear: left;"></div> <div class="footer"> |