Skip to content

Commit 0a6883c

Browse files
Rigu1rwinch
authored andcommitted
Fix Javadoc warnings in spring-security-web
* Use <code> tags for external references in DelegatingMissingAuthorityAccessDeniedHandler and SwitchUserWebFilter * Fix typo in SessionAuthenticationException * Apply javadoc-warnings-error plugin Closes gh-18468 Signed-off-by: rigu1 <dlsrbtla@gmail.com>
1 parent c07a2e5 commit 0a6883c

4 files changed

Lines changed: 6 additions & 6 deletions

File tree

web/spring-security-web.gradle

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
plugins {
22
id 'security-nullability'
3+
id 'javadoc-warnings-error'
34
}
45

56
apply plugin: 'io.spring.convention.spring-module'

web/src/main/java/org/springframework/security/web/access/DelegatingMissingAuthorityAccessDeniedHandler.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@
7878
* @since 7.0
7979
* @see AuthorizationDeniedException
8080
* @see AuthorityAuthorizationDecision
81-
* @see org.springframework.security.config.annotation.web.configurers.ExceptionHandlingConfigurer
81+
* <code>org.springframework.security.config.annotation.web.configurers.ExceptionHandlingConfigurer</code>
8282
*/
8383
public final class DelegatingMissingAuthorityAccessDeniedHandler implements AccessDeniedHandler {
8484

web/src/main/java/org/springframework/security/web/authentication/session/SessionAuthenticationException.java

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,13 @@
2222

2323
/**
2424
* Thrown by an {@link SessionAuthenticationStrategy} or
25-
* {@link ServerSessionAuthenticationStrategy} to indicate that an authentication object
26-
* is not valid for the current session, typically because the same user has exceeded the
27-
* number of sessions they are allowed to have concurrently.
25+
* {@link SessionAuthenticationStrategy} to indicate that an authentication object is not
26+
* valid for the current session, typically because the same user has exceeded the number
27+
* of sessions they are allowed to have concurrently.
2828
*
2929
* @author Luke Taylor
3030
* @since 3.0
3131
* @see SessionAuthenticationStrategy
32-
* @see ServerSessionAuthenticationStrategy
3332
*/
3433
public class SessionAuthenticationException extends AuthenticationException {
3534

web/src/main/java/org/springframework/security/web/server/authentication/SwitchUserWebFilter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@
8080
* To configure the Switch User Processing Filter, create a bean definition for the Switch
8181
* User processing filter and add to the filterChainProxy. Note that the filter must come
8282
* <b>after</b> the
83-
* {@link org.springframework.security.config.web.server.SecurityWebFiltersOrder#AUTHORIZATION}
83+
* <code>org.springframework.security.config.web.server.SecurityWebFiltersOrder#AUTHORIZATION</code>
8484
* in the chain, in order to apply the correct constraints to the <tt>switchUserUrl</tt>.
8585
* Example: <pre>
8686
* SwitchUserWebFilter filter = new SwitchUserWebFilter(userDetailsService, loginSuccessHandler, failureHandler);

0 commit comments

Comments
 (0)