aboutsummaryrefslogtreecommitdiff
path: root/website/templates/setup/maven.html
diff options
context:
space:
mode:
authorReinier Zwitserloot <reinier@zwitserloot.com>2017-06-19 23:55:24 +0200
committerReinier Zwitserloot <reinier@zwitserloot.com>2017-06-19 23:56:44 +0200
commitec6c61d82ac9ac4d8421fdc31176d373d8042e92 (patch)
tree1cf4344beda042ff76a2c8734dc4b39b05b329fb /website/templates/setup/maven.html
parent077ab5aed59a344902f4a6255f6aa686a9698533 (diff)
downloadlombok-ec6c61d82ac9ac4d8421fdc31176d373d8042e92.tar.gz
lombok-ec6c61d82ac9ac4d8421fdc31176d373d8042e92.tar.bz2
lombok-ec6c61d82ac9ac4d8421fdc31176d373d8042e92.zip
Added pages for build tools, and updated the android instructions.
Diffstat (limited to 'website/templates/setup/maven.html')
-rw-r--r--website/templates/setup/maven.html32
1 files changed, 32 insertions, 0 deletions
diff --git a/website/templates/setup/maven.html b/website/templates/setup/maven.html
new file mode 100644
index 00000000..5ca09126
--- /dev/null
+++ b/website/templates/setup/maven.html
@@ -0,0 +1,32 @@
+<#import "_setup.html" as s>
+
+<@s.scaffold title="Maven">
+ <@s.introduction>
+ <p>
+ To set up lombok with any build tool, you have to specify that the lombok dependency is required to compile your source code, but does not need to be present when running/testing/jarring/otherwise deploying your code. Generally this is called a 'provided' dependency. This page explains how to integrate lombok with the <a href="https://maven.apache.org/">Apache Maven</a> build tool.
+ </p><p>
+ Lombok is available in maven central, so telling Maven to download lombok is easy.
+ </p>
+ </@s.introduction>
+
+ <@s.section title="Adding lombok to your pom file">
+ <p>
+ To include lombok as a 'provided' dependency, add it to your <code>&lt;dependencies&gt;</code> block like so:<pre>
+&lt;dependencies&gt;
+ &lt;dependency&gt;
+ &lt;groupId&gt;org.projectlombok&lt;/groupId&gt;
+ &lt;artifactId&gt;lombok&lt;/artifactId&gt;
+ &lt;version&gt;${version}&lt;/version&gt;
+ &lt;scope&gt;provided&lt;/scope&gt;
+ &lt;/dependency&gt;
+&lt;/dependencies&gt;
+</pre>
+ </p>
+ </@s.section>
+
+ <@s.section title="Delomboking: The Lombok Maven Plugin">
+ <p>
+ There is a plugin for Maven that we recommend you use if you want to delombok via maven. Useful if you want to run source analysis tools on your source <em>after</em> lombok has been applied, or if you want to generate javadoc. The plugin is open source. Read more <a href="http://awhitford.github.io/lombok.maven/lombok-maven-plugin/">about the lombok maven plugin</a>.
+ </p>
+ </@s.section>
+</@s.scaffold>