Skip to content

Commit 6985fa8

Browse files
marcwrobelsbrannen
authored andcommitted
Fix and improve Javadoc in spring-webmvc
Closes gh-28789
1 parent 03f0c57 commit 6985fa8

File tree

50 files changed

+79
-79
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+79
-79
lines changed

spring-webmvc/src/main/java/org/springframework/web/servlet/FrameworkServlet.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -641,7 +641,7 @@ protected WebApplicationContext findWebApplicationContext() {
641641
* {@link org.springframework.web.context.ConfigurableWebApplicationContext}
642642
* interface. Can be overridden in subclasses.
643643
* <p>Do not forget to register this servlet instance as application listener on the
644-
* created context (for triggering its {@link #onRefresh callback}, and to call
644+
* created context (for triggering its {@link #onRefresh callback}), and to call
645645
* {@link org.springframework.context.ConfigurableApplicationContext#refresh()}
646646
* before returning the context instance.
647647
* @param parent the parent ApplicationContext to use, or {@code null} if none

spring-webmvc/src/main/java/org/springframework/web/servlet/HandlerAdapter.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
* <p>Note: {@code HandlerAdapter} implementors may implement the {@link
4141
* org.springframework.core.Ordered} interface to be able to specify a sorting
4242
* order (and thus a priority) for getting applied by the {@code DispatcherServlet}.
43-
* Non-Ordered instances get treated as lowest priority.
43+
* Non-Ordered instances get treated as the lowest priority.
4444
*
4545
* @author Rod Johnson
4646
* @author Juergen Hoeller
@@ -50,15 +50,15 @@
5050
public interface HandlerAdapter {
5151

5252
/**
53-
* Given a handler instance, return whether or not this {@code HandlerAdapter}
53+
* Given a handler instance, return whether this {@code HandlerAdapter}
5454
* can support it. Typical HandlerAdapters will base the decision on the handler
5555
* type. HandlerAdapters will usually only support one handler type each.
5656
* <p>A typical implementation:
5757
* <p>{@code
5858
* return (handler instanceof MyHandler);
5959
* }
6060
* @param handler the handler object to check
61-
* @return whether or not this object can use the given handler
61+
* @return whether this object can use the given handler
6262
*/
6363
boolean supports(Object handler);
6464

spring-webmvc/src/main/java/org/springframework/web/servlet/HandlerMapping.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
*
4646
* <p>Note: Implementations can implement the {@link org.springframework.core.Ordered}
4747
* interface to be able to specify a sorting order and thus a priority for getting
48-
* applied by DispatcherServlet. Non-Ordered instances get treated as lowest priority.
48+
* applied by DispatcherServlet. Non-Ordered instances get treated as the lowest priority.
4949
*
5050
* @author Rod Johnson
5151
* @author Juergen Hoeller

spring-webmvc/src/main/java/org/springframework/web/servlet/ModelAndView.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ public class ModelAndView {
5858
@Nullable
5959
private HttpStatus status;
6060

61-
/** Indicates whether or not this instance has been cleared with a call to {@link #clear()}. */
61+
/** Indicates whether this instance has been cleared with a call to {@link #clear()}. */
6262
private boolean cleared = false;
6363

6464

@@ -216,7 +216,7 @@ public View getView() {
216216
}
217217

218218
/**
219-
* Indicate whether or not this {@code ModelAndView} has a view, either
219+
* Indicate whether this {@code ModelAndView} has a view, either
220220
* as a view name or as a direct {@link View} instance.
221221
*/
222222
public boolean hasView() {

spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/DefaultServletHandlerConfigurer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ public void enable(@Nullable String defaultServletName) {
9090
* Return a handler mapping instance ordered at {@link Ordered#LOWEST_PRECEDENCE}
9191
* containing the {@link DefaultServletHttpRequestHandler} instance mapped
9292
* to {@code "/**"}; or {@code null} if default servlet handling was not
93-
* been enabled.
93+
* enabled.
9494
* @since 4.3.12
9595
*/
9696
@Nullable

spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurationSupport.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1109,7 +1109,7 @@ protected ExceptionHandlerExceptionResolver createExceptionHandlerExceptionResol
11091109
/**
11101110
* Register a {@link ViewResolverComposite} that contains a chain of view resolvers
11111111
* to use for view resolution.
1112-
* By default this resolver is ordered at 0 unless content negotiation view
1112+
* By default, this resolver is ordered at 0 unless content negotiation view
11131113
* resolution is used in which case the order is raised to
11141114
* {@link org.springframework.core.Ordered#HIGHEST_PRECEDENCE
11151115
* Ordered.HIGHEST_PRECEDENCE}.
@@ -1167,7 +1167,7 @@ protected final Map<String, CorsConfiguration> getCorsConfigurations() {
11671167
}
11681168

11691169
/**
1170-
* Override this method to configure cross origin requests processing.
1170+
* Override this method to configure cross-origin requests processing.
11711171
* @since 4.2
11721172
* @see CorsRegistry
11731173
*/

spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ default void addResourceHandlers(ResourceHandlerRegistry registry) {
105105
}
106106

107107
/**
108-
* Configure "global" cross origin request processing. The configured CORS
108+
* Configure "global" cross-origin request processing. The configured CORS
109109
* mappings apply to annotated controllers, functional endpoints, and static
110110
* resources.
111111
* <p>Annotated controllers can further declare more fine-grained config via

spring-webmvc/src/main/java/org/springframework/web/servlet/function/RequestPredicates.java

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

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

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

spring-webmvc/src/main/java/org/springframework/web/servlet/function/ServerRequest.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,7 @@ default String pathVariable(String name) {
268268
* also with conditional POST/PUT/DELETE requests.
269269
* <p><strong>Note:</strong> you can use either
270270
* this {@code #checkNotModified(Instant)} method; or
271-
* {@link #checkNotModified(String)}. If you want enforce both
271+
* {@link #checkNotModified(String)}. If you want to enforce both
272272
* a strong entity tag and a Last-Modified value,
273273
* as recommended by the HTTP specification,
274274
* then you should use {@link #checkNotModified(Instant, String)}.
@@ -302,7 +302,7 @@ default Optional<ServerResponse> checkNotModified(Instant lastModified) {
302302
* also with conditional POST/PUT/DELETE requests.
303303
* <p><strong>Note:</strong> you can use either
304304
* this {@link #checkNotModified(Instant)} method; or
305-
* {@code #checkNotModified(String)}. If you want enforce both
305+
* {@code #checkNotModified(String)}. If you want to enforce both
306306
* a strong entity tag and a Last-Modified value,
307307
* as recommended by the HTTP specification,
308308
* then you should use {@link #checkNotModified(Instant, String)}.

spring-webmvc/src/main/java/org/springframework/web/servlet/function/support/RouterFunctionMapping.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ public void afterPropertiesSet() throws Exception {
150150
}
151151

152152
/**
153-
* Detect a all {@linkplain RouterFunction router functions} in the
153+
* Detect an all {@linkplain RouterFunction router functions} in the
154154
* current application context.
155155
*/
156156
private void initRouterFunctions() {

0 commit comments

Comments
 (0)