diff options
| author | Reinier Zwitserloot <r.zwitserloot@projectlombok.org> | 2022-03-17 23:21:25 +0100 |
|---|---|---|
| committer | Reinier Zwitserloot <r.zwitserloot@projectlombok.org> | 2022-03-17 23:21:25 +0100 |
| commit | a656a04da65927780059dff564c063eb70ac8148 (patch) | |
| tree | d19d39b85da49179466fbe81165747c41ded48d1 /website/templates/features | |
| parent | 4673bc36f02f53671a7b7df79baa770fffcbc99e (diff) | |
| download | lombok-a656a04da65927780059dff564c063eb70ac8148.tar.gz lombok-a656a04da65927780059dff564c063eb70ac8148.tar.bz2 lombok-a656a04da65927780059dff564c063eb70ac8148.zip | |
[Fixes #2988] adopt suggested new text for the docs on `@ToString`.
Diffstat (limited to 'website/templates/features')
| -rw-r--r-- | website/templates/features/ToString.html | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/website/templates/features/ToString.html b/website/templates/features/ToString.html index 87e06649..c740ec81 100644 --- a/website/templates/features/ToString.html +++ b/website/templates/features/ToString.html @@ -3,7 +3,7 @@ <@f.scaffold title="@ToString" logline="No need to start a debugger to see your fields: Just let lombok generate a <code>toString</code> for you!"> <@f.overview> <p> - Any class definition may be annotated with <code>@ToString</code> to let lombok generate an implementation of the <code>toString()</code> method. By default, it'll print your class name, along with each field, in order, separated by commas. + Annotating a class with <code>@ToString</code> will cause lombok to generate an implementation of the <code>toString()</code> method. You use configuration options to specify whether field names should be included but otherwise the format is fixed: the class name followed by parentheses containing fields separated by commas, e.g. <code>MyClass(foo=123, bar=234)</code>. </p><p> By setting the <code>includeFieldNames</code> parameter to <em>true</em> you can add some clarity (but also quite some length) to the output of the <code>toString()</code> method. </p><p> |