From a656a04da65927780059dff564c063eb70ac8148 Mon Sep 17 00:00:00 2001 From: Reinier Zwitserloot Date: Thu, 17 Mar 2022 23:21:25 +0100 Subject: [Fixes #2988] adopt suggested new text for the docs on `@ToString`. --- website/templates/features/ToString.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 toString for you!"> <@f.overview>

- Any class definition may be annotated with @ToString to let lombok generate an implementation of the toString() method. By default, it'll print your class name, along with each field, in order, separated by commas. + Annotating a class with @ToString will cause lombok to generate an implementation of the toString() 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. MyClass(foo=123, bar=234).

By setting the includeFieldNames parameter to true you can add some clarity (but also quite some length) to the output of the toString() method.

-- cgit