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/ToString.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/ToString.html')
| -rw-r--r-- | website/features/ToString.html | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/website/features/ToString.html b/website/features/ToString.html index ffda89d1..6cdd8453 100644 --- a/website/features/ToString.html +++ b/website/features/ToString.html @@ -41,6 +41,17 @@ </div> </div> <div style="clear: left;"></div> + <div class="overview confKeys"> + <h3>Supported configuration keys:</h3> + <dl> + <dt><code>lombok.toString.includeFieldNames</code> = [<code>true</code> | <code>false</code>] (default: true)</dt> + <dd>Normally lombok generates a fragment of the toString response for each field in the form of <code>fieldName = fieldValue</code>. If this setting is set to <code>false</code>, lombok will omit the name of the field and simply deploy a comma-separated list of all the field values. The annotation parameter '<code>includeFieldNames</code>', if explicitly specified, takes precedence over this setting.</dd> + <dt><code>lombok.toString.doNotUseGetters</code> = [<code>true</code> | <code>false</code>] (default: false)</dt> + <dd>If set to <code>true</code>, lombok will access fields directly instead of using getters (if available) when generating <code>toString</code> methods. The annotation parameter '<code>doNotUseGetters</code>', if explicitly specified, takes precedence over this setting.</dd> + <dt><code>lombok.toString.flagUsage</code> = [<code>warning</code> | <code>error</code>] (default: not set)</dt> + <dd>Lombok will flag any usage of <code>@ToString</code> as a warning or error if configured.</dd> + </dl> + </div> <div class="overview"> <h3>Small print</h3><div class="smallprint"> <p> |