From b6ce9410b15bc645fc191c147cfd14359da67b72 Mon Sep 17 00:00:00 2001 From: Reinier Zwitserloot Date: Thu, 22 May 2014 03:30:11 +0200 Subject: added documentation for the configuration feature. --- website/features/Constructor.html | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'website/features/Constructor.html') diff --git a/website/features/Constructor.html b/website/features/Constructor.html index c7e40dfb..a3163bfa 100644 --- a/website/features/Constructor.html +++ b/website/features/Constructor.html @@ -60,6 +60,17 @@
+
+

Supported configuration keys:

+
+
lombok.anyConstructor.suppressConstructorProperties = [true | false] (default: false)
+
If set to true, then lombok will skip adding a @java.beans.ConstructorProperties to generated constructors. This is useful in android and GWT development where that annotation is not usually available.
+
lombok.[allArgsConstructor|requiredArgsConstructor|noArgsConstructor].flagUsage = [warning | error] (default: not set)
+
Lombok will flag any usage of the relevant annotation (@AllArgsConstructor, @RequiredArgsConstructor or @NoArgsConstructor) as a warning or error if configured.
+
lombok.anyConstructor.flagUsage = [warning | error] (default: not set)
+
Lombok will flag any usage of any of the 3 constructor-generating annotations as a warning or error if configured.
+
+

Small print

@@ -77,6 +88,8 @@ While suppressConstructorProperties has been marked deprecated in anticipation of a world where all java environments have the @ConstructorProperties annotation available, first GWT 2.2 and Android 2.3.3, which do not (yet) have this annotation, will have to be ancient history before this annotation parameter will be removed. +

+ The flagUsage configuration keys do not trigger when a constructor is generated by @Data, @Value or any other lombok annotation.

-- cgit