From b87954fe7892e9b363cda6224df79fadac1ce68e Mon Sep 17 00:00:00 2001 From: Georgios Andrianakis Date: Mon, 24 Jul 2023 14:15:28 +0300 Subject: [PATCH] Improve Javadoc of @CustomSerialization Relates to: #34934 --- .../reactive/jackson/CustomSerialization.java | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/extensions/resteasy-reactive/quarkus-resteasy-reactive-jackson/runtime/src/main/java/io/quarkus/resteasy/reactive/jackson/CustomSerialization.java b/extensions/resteasy-reactive/quarkus-resteasy-reactive-jackson/runtime/src/main/java/io/quarkus/resteasy/reactive/jackson/CustomSerialization.java index ee77dcba83901..b606620691ad6 100644 --- a/extensions/resteasy-reactive/quarkus-resteasy-reactive-jackson/runtime/src/main/java/io/quarkus/resteasy/reactive/jackson/CustomSerialization.java +++ b/extensions/resteasy-reactive/quarkus-resteasy-reactive-jackson/runtime/src/main/java/io/quarkus/resteasy/reactive/jackson/CustomSerialization.java @@ -26,15 +26,18 @@ * needed * (this type will be a generic type if the method returns such a generic type) and returns the instance of the custom * {@code ObjectWriter}. - * + *

* Quarkus will construct one instance of this {@code BiFunction} for each JAX-RS resource method that is annotated with * {@code CustomSerialization} and once an instance is created it will be cached for subsequent usage by that resource * method. - * - * The class MUST contain a no-args constructor and it is advisable that it contains no state that is updated outside + *

+ * The {@code BiFunction} MUST contain a no-args constructor. + *

+ * Furthermore, it is advisable that it contains no state that is updated outside * its constructor. - * Furthermore, the {@code ObjectMapper} should NEVER be changed any way as it is the global ObjectMapper that is - * accessible to the entire Quarkus application. + *

+ * Finally and most importantly, the {@code ObjectMapper} should NEVER be changed any way as it is the global ObjectMapper + * that is accessible to the entire Quarkus application. */ Class> value(); }