From 86b87d7d8506a914dab948629db930d227c90507 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=81ukasz=20Jerna=C5=9B?= Date: Sat, 30 Mar 2024 15:44:41 +0100 Subject: [PATCH] Prevent package summaries from being truncated due to incorrect sentence detection Javadoc doesn't seem to like having `e.g.` as it thinks the sentence ends there, which is usually incorrect and results in broken descriptions. This commit rewords the doc strings slightly to avoid problematic parts. Closes gh-32532 --- .../org/springframework/core/type/filter/package-info.java | 2 +- .../org/springframework/web/reactive/result/package-info.java | 4 ++-- .../web/reactive/result/view/script/package-info.java | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/spring-core/src/main/java/org/springframework/core/type/filter/package-info.java b/spring-core/src/main/java/org/springframework/core/type/filter/package-info.java index 7c60af6640..3828844388 100644 --- a/spring-core/src/main/java/org/springframework/core/type/filter/package-info.java +++ b/spring-core/src/main/java/org/springframework/core/type/filter/package-info.java @@ -1,5 +1,5 @@ /** - * Core support package for type filtering (e.g. for classpath scanning). + * Core support package for type filtering (for example for classpath scanning). */ @NonNullApi @NonNullFields diff --git a/spring-webflux/src/main/java/org/springframework/web/reactive/result/package-info.java b/spring-webflux/src/main/java/org/springframework/web/reactive/result/package-info.java index 49f08e4f43..ac3824fbc1 100644 --- a/spring-webflux/src/main/java/org/springframework/web/reactive/result/package-info.java +++ b/spring-webflux/src/main/java/org/springframework/web/reactive/result/package-info.java @@ -1,7 +1,7 @@ /** * Support for various programming model styles including the invocation of - * different types of handlers, e.g. annotated controller vs simple WebHandler, - * including the handling of handler result values, e.g. @ResponseBody, view + * different types of handlers like an annotated controller or a simple WebHandler. + * Includes the handling of handler result values, e.g. @ResponseBody, view * resolution, and so on. */ @NonNullApi diff --git a/spring-webflux/src/main/java/org/springframework/web/reactive/result/view/script/package-info.java b/spring-webflux/src/main/java/org/springframework/web/reactive/result/view/script/package-info.java index 268b1dbe73..f1876c0bcc 100644 --- a/spring-webflux/src/main/java/org/springframework/web/reactive/result/view/script/package-info.java +++ b/spring-webflux/src/main/java/org/springframework/web/reactive/result/view/script/package-info.java @@ -1,6 +1,6 @@ /** * Support classes for views based on the JSR-223 script engine abstraction - * (as included in Java 6+), e.g. using JavaScript via Nashorn on JDK 8. + * (as included in Java 6+). For example using JavaScript via Nashorn on JDK 8. * Contains a View implementation for scripted templates. */ @NonNullApi