Skip to content

Commit 86b87d7

Browse files
authored
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
1 parent 186e70c commit 86b87d7

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

spring-core/src/main/java/org/springframework/core/type/filter/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Core support package for type filtering (e.g. for classpath scanning).
2+
* Core support package for type filtering (for example for classpath scanning).
33
*/
44
@NonNullApi
55
@NonNullFields

spring-webflux/src/main/java/org/springframework/web/reactive/result/package-info.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/**
22
* Support for various programming model styles including the invocation of
3-
* different types of handlers, e.g. annotated controller vs simple WebHandler,
4-
* including the handling of handler result values, e.g. @ResponseBody, view
3+
* different types of handlers like an annotated controller or a simple WebHandler.
4+
* Includes the handling of handler result values, e.g. @ResponseBody, view
55
* resolution, and so on.
66
*/
77
@NonNullApi

spring-webflux/src/main/java/org/springframework/web/reactive/result/view/script/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* Support classes for views based on the JSR-223 script engine abstraction
3-
* (as included in Java 6+), e.g. using JavaScript via Nashorn on JDK 8.
3+
* (as included in Java 6+). For example using JavaScript via Nashorn on JDK 8.
44
* Contains a View implementation for scripted templates.
55
*/
66
@NonNullApi

0 commit comments

Comments
 (0)