diff options
| author | Reinier Zwitserloot <reinier@zwitserloot.com> | 2014-05-22 03:30:11 +0200 |
|---|---|---|
| committer | Reinier Zwitserloot <reinier@zwitserloot.com> | 2014-05-22 03:31:18 +0200 |
| commit | b6ce9410b15bc645fc191c147cfd14359da67b72 (patch) | |
| tree | 8c51173307faf35588bbfac07b34b93bb2ee7b2c /website/features/Constructor.html | |
| parent | 0e673c6b3004a67c760bcbbabdc8abbf35c70722 (diff) | |
| download | lombok-b6ce9410b15bc645fc191c147cfd14359da67b72.tar.gz lombok-b6ce9410b15bc645fc191c147cfd14359da67b72.tar.bz2 lombok-b6ce9410b15bc645fc191c147cfd14359da67b72.zip | |
added documentation for the configuration feature.
Diffstat (limited to 'website/features/Constructor.html')
| -rw-r--r-- | website/features/Constructor.html | 13 |
1 files changed, 13 insertions, 0 deletions
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 @@ </div> </div> <div style="clear: left;"></div> + <div class="overview confKeys"> + <h3>Supported configuration keys:</h3> + <dl> + <dt><code>lombok.anyConstructor.suppressConstructorProperties</code> = [<code>true</code> | <code>false</code>] (default: <code>false</code>)</dt> + <dd>If set to <code>true</code>, then lombok will skip adding a <code>@java.beans.ConstructorProperties</code> to generated constructors. This is useful in android and GWT development where that annotation is not usually available.</dd> + <dt><code>lombok.</code>[<code>allArgsConstructor</code>|<code>requiredArgsConstructor</code>|<code>noArgsConstructor</code>]<code>.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt> + <dd>Lombok will flag any usage of the relevant annotation (<code>@AllArgsConstructor</code>, <code>@RequiredArgsConstructor</code> or <code>@NoArgsConstructor</code>) as a warning or error if configured.</dd> + <dt><code>lombok.anyConstructor.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt> + <dd>Lombok will flag any usage of any of the 3 constructor-generating annotations as a warning or error if configured.</dd> + </dl> + </div> <div class="overview"> <h3>Small print</h3><div class="smallprint"> <p> @@ -77,6 +88,8 @@ While <code>suppressConstructorProperties</code> has been marked deprecated in anticipation of a world where all java environments have the <code>@ConstructorProperties</code> 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. + </p><p> + The <code>flagUsage</code> configuration keys do not trigger when a constructor is generated by <code>@Data</code>, <code>@Value</code> or any other lombok annotation. </p> </div> </div> |