From 2caddc3c2a4431aa5d2ffd4e4d1840dbd7c09a64 Mon Sep 17 00:00:00 2001 From: Reinier Zwitserloot Date: Fri, 27 Nov 2009 15:22:43 +0100 Subject: Added documentation for delombok. --- website/features/index.html | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'website/features/index.html') diff --git a/website/features/index.html b/website/features/index.html index d7f640ac..9157f503 100644 --- a/website/features/index.html +++ b/website/features/index.html @@ -35,6 +35,20 @@ The documentation above is a lot easier to follow, but if you want to build your own transformations, or you want to add javadoc to lombok.jar in your IDE, you can also check out the javadoc. +

Running Lombok

+

On eclipse

+ Execute lombok.jar (doubleclick it, or run java -jar lombok.jar). Follow instructions. +

On javac (and maven, ant, and other build tools)

+ Include lombok.jar on the classpath as you compile. That's all there is to it!
+ Lombok hosts its own maven repository, so adding lombok to maven is very simple. full instructions are here. +

On GWT (Google Widget Toolkit), javadoc, and other source-based tools

+ Use delombok first, then run javadoc or GWT on the delombok-ed code. +

Running delombok

+
Delombok copies your source files to another directory, replacing all lombok annotations with their desugared form. So, it'll turn @Getter + back into the actual getter. It then removes the annotation. This is useful for all sorts of reasons; you can check out what's happening under the hood, + if the unthinkable happens and you want to stop using lombok, you can easily remove all traces of it in your source, and you can use delombok to preprocess + your source files for source-level tools such as javadoc and GWT. More information about how to run delombok, including instructions for build tools + can be found at the delombok page.
credits | Copyright © 2009 Reinier Zwitserloot and Roel Spilker, licensed under the MIT license.
-- cgit