aboutsummaryrefslogtreecommitdiff
path: root/website/features/experimental
diff options
context:
space:
mode:
authorReinier Zwitserloot <reinier@zwitserloot.com>2014-05-22 03:30:11 +0200
committerReinier Zwitserloot <reinier@zwitserloot.com>2014-05-22 03:31:18 +0200
commitb6ce9410b15bc645fc191c147cfd14359da67b72 (patch)
tree8c51173307faf35588bbfac07b34b93bb2ee7b2c /website/features/experimental
parent0e673c6b3004a67c760bcbbabdc8abbf35c70722 (diff)
downloadlombok-b6ce9410b15bc645fc191c147cfd14359da67b72.tar.gz
lombok-b6ce9410b15bc645fc191c147cfd14359da67b72.tar.bz2
lombok-b6ce9410b15bc645fc191c147cfd14359da67b72.zip
added documentation for the configuration feature.
Diffstat (limited to 'website/features/experimental')
-rw-r--r--website/features/experimental/Accessors.html13
-rw-r--r--website/features/experimental/Builder.html7
-rw-r--r--website/features/experimental/Delegate.html7
-rw-r--r--website/features/experimental/ExtensionMethod.html7
-rw-r--r--website/features/experimental/FieldDefaults.html7
-rw-r--r--website/features/experimental/Wither.html7
-rw-r--r--website/features/experimental/index.html7
7 files changed, 55 insertions, 0 deletions
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 @@
</div>
</div>
<div style="clear: left;"></div>
+ <div class="overview confKeys">
+ <h3>Supported configuration keys:</h3>
+ <dl>
+ <dt><code>lombok.accessors.chain</code> = [<code>true</code> | <code>false</code>] (default: false)</dt>
+ <dd>If set to <code>true</code>, any class that either doesn't have an <code>@Accessors</code> annotation, or it does, but that annotation does not have an explicit value for the <code>chain</code> parameter, will act as if <code>@Accessors(chain = true)</code> is present.</dd>
+ <dt><code>lombok.accessors.fluent</code> = [<code>true</code> | <code>false</code>] (default: false)</dt>
+ <dd>If set to <code>true</code>, any class that either doesn't have an <code>@Accessors</code> annotation, or it does, but that annotation does not have an explicit value for the <code>fluent</code> parameter, will act as if <code>@Accessors(fluent = true)</code> is present.</dd>
+ <dt><code>lombok.accessors.prefix</code> += <em>a field prefix</em> (default: empty list)</dt>
+ <dd>This is a list property; entries can be added with the <code>+=</code> operator. Inherited prefixes from parent config files can be removed with the <code>-=</code> operator. Any class that either doesn't have an <code>@Accessors</code> annotation, or it does, but that annotation does not have an explicit value for the <code>prefix</code> parameter, will act as if <code>@Accessors(prefix = {<em>prefixes listed in configuration</em>})</code> is present.</dd>
+ <dt><code>lombok.accessors.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt>
+ <dd>Lombok will flag any usage of <code>@Accessors</code> as a warning or error if configured.</dd>
+ </dl>
+ </div>
<div class="overview">
<h3>Small print</h3><div class="smallprint">
<p>
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 @@
</div>
</div>
<div style="clear: left;"></div>
+ <div class="overview confKeys">
+ <h3>Supported configuration keys:</h3>
+ <dl>
+ <dt><code>lombok.builder.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt>
+ <dd>Lombok will flag any usage of <code>@Builder</code> as a warning or error if configured.</dd>
+ </dl>
+ </div>
<div class="overview">
<h3>Small print</h3><div class="smallprint">
<p>
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 @@
</div>
</div>
<div style="clear: left;"></div>
+ <div class="overview confKeys">
+ <h3>Supported configuration keys:</h3>
+ <dl>
+ <dt><code>lombok.delegate.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt>
+ <dd>Lombok will flag any usage of <code>@Delegate</code> as a warning or error if configured.</dd>
+ </dl>
+ </div>
<div class="overview">
<h3>Small print</h3><div class="smallprint">
<p>
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!"));</pre>
</div>
</div>
<div style="clear: left;"></div>
+ <div class="overview confKeys">
+ <h3>Supported configuration keys:</h3>
+ <dl>
+ <dt><code>lombok.extensionMethod.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt>
+ <dd>Lombok will flag any usage of <code>@ExtensionMethod</code> as a warning or error if configured.</dd>
+ </dl>
+ </div>
<div class="overview">
<h3>Small print</h3><div class="smallprint">
<p>
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 @@
</div>
</div>
<div style="clear: left;"></div>
+ <div class="overview confKeys">
+ <h3>Supported configuration keys:</h3>
+ <dl>
+ <dt><code>lombok.fieldDefaults.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt>
+ <dd>Lombok will flag any usage of <code>@FieldDefaults</code> as a warning or error if configured.</dd>
+ </dl>
+ </div>
<div class="overview">
<h3>Small print</h3><div class="smallprint">
<p>
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 @@
</div>
</div>
<div style="clear: left;"></div>
+ <div class="overview confKeys">
+ <h3>Supported configuration keys:</h3>
+ <dl>
+ <dt><code>lombok.wither.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt>
+ <dd>Lombok will flag any usage of <code>@Wither</code> as a warning or error if configured.</dd>
+ </dl>
+ </div>
<div class="overview">
<h3>Small print</h3><div class="smallprint">
<p>
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 @@
<dd>Sup dawg, we heard you like annotations, so we put annotations in your annotations so you can annotate while you're annotating.</dd>
</dl>
</div>
+ <div class="overview confKeys">
+ <h3>Supported configuration keys:</h3>
+ <dl>
+ <dt><code>lombok.experimental.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt>
+ <dd>Lombok will flag any usage of any of the features listed here as a warning or error if configured.</dd>
+ </dl>
+ </div>
<div class="index overview">
<h3>Putting the "Ex" in "Experimental": promoted or deleted experimental features.</h3>
<dl>