Skip to content

Commit 31c6965

Browse files
marcwrobelsbrannen
authored andcommitted
Fix and improve Javadoc in spring-webflux
Closes gh-28790
1 parent 5b1a84e commit 31c6965

34 files changed

+44
-44
lines changed

spring-webflux/src/main/java/org/springframework/web/reactive/HandlerAdapter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ public interface HandlerAdapter {
3535
/**
3636
* Whether this {@code HandlerAdapter} supports the given {@code handler}.
3737
* @param handler the handler object to check
38-
* @return whether or not the handler is supported
38+
* @return whether the handler is supported
3939
*/
4040
boolean supports(Object handler);
4141

spring-webflux/src/main/java/org/springframework/web/reactive/HandlerResultHandler.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ public interface HandlerResultHandler {
3232
/**
3333
* Whether this handler supports the given {@link HandlerResult}.
3434
* @param result the result object to check
35-
* @return whether or not this object can use the given result
35+
* @return whether this object can use the given result
3636
*/
3737
boolean supports(HandlerResult result);
3838

spring-webflux/src/main/java/org/springframework/web/reactive/accept/ParameterContentTypeResolver.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
import org.springframework.web.server.ServerWebExchange;
3232

3333
/**
34-
* Resolver that checks a query parameter and uses it to lookup a matching
34+
* Resolver that checks a query parameter and uses it to look up a matching
3535
* MediaType. Lookup keys can be registered or as a fallback
3636
* {@link MediaTypeFactory} can be used to perform a lookup.
3737
*

spring-webflux/src/main/java/org/springframework/web/reactive/config/WebFluxConfigurationSupport.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ private void configureAbstractHandlerMapping(AbstractHandlerMapping mapping, Pat
155155
}
156156

157157
/**
158-
* Override to plug a sub-class of {@link RequestMappingHandlerMapping}.
158+
* Override to plug a subclass of {@link RequestMappingHandlerMapping}.
159159
*/
160160
protected RequestMappingHandlerMapping createRequestMappingHandlerMapping() {
161161
return new RequestMappingHandlerMapping();
@@ -176,7 +176,7 @@ protected void configureContentTypeResolver(RequestedContentTypeResolverBuilder
176176

177177
/**
178178
* Callback for building the global CORS configuration. This method is final.
179-
* Use {@link #addCorsMappings(CorsRegistry)} to customize the CORS conifg.
179+
* Use {@link #addCorsMappings(CorsRegistry)} to customize the CORS config.
180180
*/
181181
protected final Map<String, CorsConfiguration> getCorsConfigurations() {
182182
if (this.corsConfigurations == null) {
@@ -188,7 +188,7 @@ protected final Map<String, CorsConfiguration> getCorsConfigurations() {
188188
}
189189

190190
/**
191-
* Override this method to configure cross origin requests processing.
191+
* Override this method to configure cross-origin requests processing.
192192
* @see CorsRegistry
193193
*/
194194
protected void addCorsMappings(CorsRegistry registry) {
@@ -222,7 +222,7 @@ public RouterFunctionMapping routerFunctionMapping(ServerCodecConfigurer serverC
222222
}
223223

224224
/**
225-
* Override to plug a sub-class of {@link RouterFunctionMapping}.
225+
* Override to plug a subclass of {@link RouterFunctionMapping}.
226226
*/
227227
protected RouterFunctionMapping createRouterFunctionMapping() {
228228
return new RouterFunctionMapping();
@@ -285,7 +285,7 @@ public RequestMappingHandlerAdapter requestMappingHandlerAdapter(
285285
}
286286

287287
/**
288-
* Override to plug a sub-class of {@link RequestMappingHandlerAdapter}.
288+
* Override to plug a subclass of {@link RequestMappingHandlerAdapter}.
289289
*/
290290
protected RequestMappingHandlerAdapter createRequestMappingHandlerAdapter() {
291291
return new RequestMappingHandlerAdapter();
@@ -310,7 +310,7 @@ public ServerCodecConfigurer serverCodecConfigurer() {
310310
}
311311

312312
/**
313-
* Override to plug a sub-class of {@link LocaleContextResolver}.
313+
* Override to plug a subclass of {@link LocaleContextResolver}.
314314
*/
315315
protected LocaleContextResolver createLocaleContextResolver() {
316316
return new AcceptHeaderLocaleContextResolver();

spring-webflux/src/main/java/org/springframework/web/reactive/config/WebFluxConfigurer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ default void configureContentTypeResolver(RequestedContentTypeResolverBuilder bu
5454
}
5555

5656
/**
57-
* Configure "global" cross origin request processing. The configured CORS
57+
* Configure "global" cross-origin request processing. The configured CORS
5858
* mappings apply to annotated controllers, functional endpoints, and static
5959
* resources.
6060
* <p>Annotated controllers can further declare more fine-grained config via

spring-webflux/src/main/java/org/springframework/web/reactive/function/BodyExtractors.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ private static <T> Flux<T> unsupportedErrorHandler(
224224

225225
Flux<T> result;
226226
if (message.getHeaders().getContentType() == null) {
227-
// Maybe it's okay there is no content type, if there is no content..
227+
// Maybe it's okay there is no content type, if there is no content.
228228
result = message.getBody().map(buffer -> {
229229
DataBufferUtils.release(buffer);
230230
throw ex;

spring-webflux/src/main/java/org/springframework/web/reactive/function/client/WebClientResponseException.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -414,7 +414,7 @@ public static class NotImplemented extends WebClientResponseException {
414414
}
415415

416416
/**
417-
* {@link WebClientResponseException} for status HTTP HTTP 502 Bad Gateway.
417+
* {@link WebClientResponseException} for HTTP status 502 Bad Gateway.
418418
* @since 5.1
419419
*/
420420
@SuppressWarnings("serial")

spring-webflux/src/main/java/org/springframework/web/reactive/function/server/RequestPredicates.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -336,14 +336,14 @@ public interface Visitor {
336336
void method(Set<HttpMethod> methods);
337337

338338
/**
339-
* Receive notification of an path predicate.
339+
* Receive notification of a path predicate.
340340
* @param pattern the path pattern that makes up the predicate
341341
* @see RequestPredicates#path(String)
342342
*/
343343
void path(String pattern);
344344

345345
/**
346-
* Receive notification of an path extension predicate.
346+
* Receive notification of a path extension predicate.
347347
* @param extension the path extension that makes up the predicate
348348
* @see RequestPredicates#pathExtension(String)
349349
*/

spring-webflux/src/main/java/org/springframework/web/reactive/function/server/RouterFunctions.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ public static RouterFunction<ServerResponse> resources(Function<ServerRequest, M
205205
* for additional filter and exception handler registration through
206206
* {@link WebHttpHandlerBuilder}.
207207
* @param routerFunction the router function to convert
208-
* @return an http handler that handles HTTP request using the given router function
208+
* @return an HTTP handler that handles HTTP request using the given router function
209209
*/
210210
public static HttpHandler toHttpHandler(RouterFunction<?> routerFunction) {
211211
return toHttpHandler(routerFunction, HandlerStrategies.withDefaults());
@@ -225,7 +225,7 @@ public static HttpHandler toHttpHandler(RouterFunction<?> routerFunction) {
225225
* </ul>
226226
* @param routerFunction the router function to convert
227227
* @param strategies the strategies to use
228-
* @return an http handler that handles HTTP request using the given router function
228+
* @return an HTTP handler that handles HTTP request using the given router function
229229
*/
230230
public static HttpHandler toHttpHandler(RouterFunction<?> routerFunction, HandlerStrategies strategies) {
231231
WebHandler webHandler = toWebHandler(routerFunction, strategies);

spring-webflux/src/main/java/org/springframework/web/reactive/function/server/ServerRequest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -319,7 +319,7 @@ default String pathVariable(String name) {
319319
* also with conditional POST/PUT/DELETE requests.
320320
* <p><strong>Note:</strong> you can use either
321321
* this {@code #checkNotModified(Instant)} method; or
322-
* {@link #checkNotModified(String)}. If you want enforce both
322+
* {@link #checkNotModified(String)}. If you want to enforce both
323323
* a strong entity tag and a Last-Modified value,
324324
* as recommended by the HTTP specification,
325325
* then you should use {@link #checkNotModified(Instant, String)}.

0 commit comments

Comments
 (0)