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/experimental/Accessors.html | 13 +++++++++++++ website/features/experimental/Builder.html | 7 +++++++ website/features/experimental/Delegate.html | 7 +++++++ website/features/experimental/ExtensionMethod.html | 7 +++++++ website/features/experimental/FieldDefaults.html | 7 +++++++ website/features/experimental/Wither.html | 7 +++++++ website/features/experimental/index.html | 7 +++++++ 7 files changed, 55 insertions(+) (limited to 'website/features/experimental') diff --git a/website/features/experimental/Accessors.html b/website/features/experimental/Accessors.html index 79c3d272..20590a07 100644 --- a/website/features/experimental/Accessors.html +++ b/website/features/experimental/Accessors.html @@ -72,6 +72,19 @@
+
+

Supported configuration keys:

+
+
lombok.accessors.chain = [true | false] (default: false)
+
If set to true, any class that either doesn't have an @Accessors annotation, or it does, but that annotation does not have an explicit value for the chain parameter, will act as if @Accessors(chain = true) is present.
+
lombok.accessors.fluent = [true | false] (default: false)
+
If set to true, any class that either doesn't have an @Accessors annotation, or it does, but that annotation does not have an explicit value for the fluent parameter, will act as if @Accessors(fluent = true) is present.
+
lombok.accessors.prefix += a field prefix (default: empty list)
+
This is a list property; entries can be added with the += operator. Inherited prefixes from parent config files can be removed with the -= operator. Any class that either doesn't have an @Accessors annotation, or it does, but that annotation does not have an explicit value for the prefix parameter, will act as if @Accessors(prefix = {prefixes listed in configuration}) is present.
+
lombok.accessors.flagUsage = [warning | error] (default: not set)
+
Lombok will flag any usage of @Accessors as a warning or error if configured.
+
+

Small print

diff --git a/website/features/experimental/Builder.html b/website/features/experimental/Builder.html index 84452299..a8e21b9a 100644 --- a/website/features/experimental/Builder.html +++ b/website/features/experimental/Builder.html @@ -91,6 +91,13 @@

+
+

Supported configuration keys:

+
+
lombok.builder.flagUsage = [warning | error] (default: not set)
+
Lombok will flag any usage of @Builder as a warning or error if configured.
+
+

Small print

diff --git a/website/features/experimental/Delegate.html b/website/features/experimental/Delegate.html index 41a36d82..bd4fc393 100644 --- a/website/features/experimental/Delegate.html +++ b/website/features/experimental/Delegate.html @@ -59,6 +59,13 @@

+
+

Supported configuration keys:

+
+
lombok.delegate.flagUsage = [warning | error] (default: not set)
+
Lombok will flag any usage of @Delegate as a warning or error if configured.
+
+

Small print

diff --git a/website/features/experimental/ExtensionMethod.html b/website/features/experimental/ExtensionMethod.html index b2c751b9..58aaf1b3 100644 --- a/website/features/experimental/ExtensionMethod.html +++ b/website/features/experimental/ExtensionMethod.html @@ -77,6 +77,13 @@ System.out.println(x.or("Hello, World!"));

+
+

Supported configuration keys:

+
+
lombok.extensionMethod.flagUsage = [warning | error] (default: not set)
+
Lombok will flag any usage of @ExtensionMethod as a warning or error if configured.
+
+

Small print

diff --git a/website/features/experimental/FieldDefaults.html b/website/features/experimental/FieldDefaults.html index 159938a5..12ea7d80 100644 --- a/website/features/experimental/FieldDefaults.html +++ b/website/features/experimental/FieldDefaults.html @@ -56,6 +56,13 @@

+
+

Supported configuration keys:

+
+
lombok.fieldDefaults.flagUsage = [warning | error] (default: not set)
+
Lombok will flag any usage of @FieldDefaults as a warning or error if configured.
+
+

Small print

diff --git a/website/features/experimental/Wither.html b/website/features/experimental/Wither.html index 12475f6e..9ca43a46 100644 --- a/website/features/experimental/Wither.html +++ b/website/features/experimental/Wither.html @@ -62,6 +62,13 @@

+
+

Supported configuration keys:

+
+
lombok.wither.flagUsage = [warning | error] (default: not set)
+
Lombok will flag any usage of @Wither as a warning or error if configured.
+
+

Small print

diff --git a/website/features/experimental/index.html b/website/features/experimental/index.html index 2c641228..f37712e0 100644 --- a/website/features/experimental/index.html +++ b/website/features/experimental/index.html @@ -38,6 +38,13 @@

Sup dawg, we heard you like annotations, so we put annotations in your annotations so you can annotate while you're annotating.
+
+

Supported configuration keys:

+
+
lombok.experimental.flagUsage = [warning | error] (default: not set)
+
Lombok will flag any usage of any of the features listed here as a warning or error if configured.
+
+

Putting the "Ex" in "Experimental": promoted or deleted experimental features.

-- cgit