Skip to content

Commit 3ca4c78

Browse files
committed
Fix javadoc warnings and apply plugin javadoc-warnings-error
Closes to gh-18448 Signed-off-by: Michael Lück <michael@lueckonline.net>
1 parent 42e1e9f commit 3ca4c78

6 files changed

Lines changed: 24 additions & 24 deletions

File tree

config/spring-security-config.gradle

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ apply plugin: 'io.spring.convention.spring-module'
55
apply plugin: 'trang'
66
apply plugin: 'security-kotlin'
77
apply plugin: 'test-compile-target-jdk25'
8+
apply plugin: 'javadoc-warnings-error'
89

910
configurations {
1011
opensaml5 {

config/src/main/java/org/springframework/security/config/annotation/web/builders/HttpSecurity.java

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1881,7 +1881,7 @@ public HttpSecurity addFilterAt(Filter filter, Class<? extends Filter> atFilter)
18811881
*
18821882
* <p>
18831883
* Invoking {@link #securityMatchers(Customizer)} will not override previous
1884-
* invocations of {@link #securityMatchers()}, {@link #securityMatchers(Customizer)}
1884+
* invocations of {@link #securityMatchers(Customizer)}
18851885
* {@link #securityMatcher(String...)} and {@link #securityMatcher(RequestMatcher)}
18861886
* </p>
18871887
*
@@ -2004,8 +2004,7 @@ public HttpSecurity securityMatchers(Customizer<RequestMatcherConfigurer> reques
20042004
* <p>
20052005
* Invoking {@link #securityMatcher(RequestMatcher)} will override previous
20062006
* invocations of {@link #securityMatcher(RequestMatcher)},
2007-
* {@link #securityMatcher(String...)}, {@link #securityMatchers(Customizer)} and
2008-
* {@link #securityMatchers()}
2007+
* {@link #securityMatcher(String...)} and {@link #securityMatchers(Customizer)}
20092008
* </p>
20102009
* @param requestMatcher the {@link RequestMatcher} to use, for example,
20112010
* {@code PathPatternRequestMatcher.pathPattern(HttpMethod.GET, "/admin/**")}
@@ -2024,9 +2023,8 @@ public HttpSecurity securityMatcher(RequestMatcher requestMatcher) {
20242023
*
20252024
* <p>
20262025
* Invoking {@link #securityMatcher(String...)} will override previous invocations of
2027-
* {@link #securityMatcher(String...)} (String)}},
2028-
* {@link #securityMatcher(RequestMatcher)} ()}, {@link #securityMatchers(Customizer)}
2029-
* (String)} and {@link #securityMatchers()} (String)}.
2026+
* {@link #securityMatcher(String...)}, {@link #securityMatcher(RequestMatcher)} and
2027+
* {@link #securityMatchers(Customizer)}.
20302028
* </p>
20312029
* @param patterns the pattern to match on (i.e. "/admin/**")
20322030
* @return the {@link HttpSecurity} for further customizations

config/src/main/java/org/springframework/security/config/annotation/web/builders/WebSecurity.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ public WebSecurity debug(boolean debugEnabled) {
226226
*
227227
* <p>
228228
* Typically this method is invoked automatically within the framework from
229-
* {@link WebSecurityConfiguration#springSecurityFilterChain()}
229+
* {@link WebSecurityConfiguration#springSecurityFilterChain(ObjectProvider)}
230230
* </p>
231231
* @param securityFilterChainBuilder the builder to use to create the
232232
* {@link SecurityFilterChain} instances

config/src/main/java/org/springframework/security/config/annotation/web/configurers/oauth2/client/OAuth2ClientConfigurer.java

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@
4747
* The following configuration options are available:
4848
*
4949
* <ul>
50-
* <li>{@link #authorizationCodeGrant()} - support for the OAuth 2.0 Authorization Code
51-
* Grant</li>
50+
* <li>{@link #authorizationCodeGrant(Customizer)} - support for the OAuth 2.0
51+
* Authorization Code Grant</li>
5252
* </ul>
5353
*
5454
* <p>
@@ -59,7 +59,8 @@
5959
*
6060
* <h2>Security Filters</h2>
6161
*
62-
* The following {@code Filter}'s are populated for {@link #authorizationCodeGrant()}:
62+
* The following {@code Filter}'s are populated for
63+
* {@link #authorizationCodeGrant(Customizer)}:
6364
*
6465
* <ul>
6566
* <li>{@link OAuth2AuthorizationRequestRedirectFilter}</li>

config/src/main/java/org/springframework/security/config/annotation/web/configurers/saml2/Saml2MetadataConfigurer.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
import org.opensaml.core.Version;
2222

2323
import org.springframework.context.ApplicationContext;
24+
import org.springframework.security.config.Customizer;
2425
import org.springframework.security.config.annotation.web.HttpSecurityBuilder;
2526
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
2627
import org.springframework.security.config.annotation.web.configurers.AbstractHttpConfigurer;
@@ -42,7 +43,8 @@
4243
*
4344
* <p>
4445
* Defaults are provided for all configuration options with the only required
45-
* configuration being a {@link Saml2LoginConfigurer#relyingPartyRegistrationRepository}.
46+
* configuration being a
47+
* {@link Saml2LoginConfigurer#relyingPartyRegistrationRepository(HttpSecurityBuilder)}.
4648
* Alternatively, a {@link RelyingPartyRegistrationRepository} {@code @Bean} may be
4749
* registered instead.
4850
*
@@ -67,7 +69,7 @@
6769
* </ul>
6870
*
6971
* @since 6.1
70-
* @see HttpSecurity#saml2Metadata()
72+
* @see HttpSecurity#saml2Metadata(Customizer)
7173
* @see Saml2MetadataFilter
7274
* @see RelyingPartyRegistrationRepository
7375
*/

config/src/main/java/org/springframework/security/config/web/server/ServerHttpSecurity.java

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2162,7 +2162,7 @@ private ServerAuthenticationFailureHandler authenticationFailureHandler() {
21622162
*
21632163
* @author Evgeniy Cheban
21642164
* @since 5.6
2165-
* @see #passwordManagement()
2165+
* @see #passwordManagement(Customizer)
21662166
*/
21672167
public final class PasswordManagementSpec {
21682168

@@ -2663,7 +2663,7 @@ public HeaderSpec crossOriginResourcePolicy(
26632663
/**
26642664
* Configures cache control headers
26652665
*
2666-
* @see #cache()
2666+
* @see HeaderSpec#cache(Customizer)
26672667
*/
26682668
public final class CacheSpec {
26692669

@@ -2684,7 +2684,7 @@ public HeaderSpec disable() {
26842684
/**
26852685
* The content type headers
26862686
*
2687-
* @see #contentTypeOptions()
2687+
* @see HeaderSpec#contentTypeOptions(Customizer)
26882688
*/
26892689
public final class ContentTypeOptionsSpec {
26902690

@@ -2705,7 +2705,7 @@ public HeaderSpec disable() {
27052705
/**
27062706
* Configures frame options response header
27072707
*
2708-
* @see #frameOptions()
2708+
* @see HeaderSpec#frameOptions(Customizer)
27092709
*/
27102710
public final class FrameOptionsSpec {
27112711

@@ -2737,7 +2737,7 @@ public HeaderSpec disable() {
27372737
/**
27382738
* Configures Strict Transport Security response header
27392739
*
2740-
* @see #hsts()
2740+
* @see HeaderSpec#hsts(Customizer)
27412741
*/
27422742
public final class HstsSpec {
27432743

@@ -2796,7 +2796,7 @@ public HeaderSpec disable() {
27962796
/**
27972797
* Configures x-xss-protection response header
27982798
*
2799-
* @see #xssProtection()
2799+
* @see HeaderSpec#xssProtection(Customizer)
28002800
*/
28012801
public final class XssProtectionSpec {
28022802

@@ -2830,7 +2830,7 @@ public HeaderSpec headerValue(XXssProtectionServerHttpHeadersWriter.HeaderValue
28302830
* Configures {@code Content-Security-Policy} response header.
28312831
*
28322832
* @since 5.1
2833-
* @see #contentSecurityPolicy(String)
2833+
* @see HeaderSpec#contentSecurityPolicy(Customizer)
28342834
*/
28352835
public final class ContentSecurityPolicySpec {
28362836

@@ -2884,8 +2884,7 @@ private FeaturePolicySpec(String policyDirectives) {
28842884
* Allows method chaining to continue configuring the
28852885
* {@link ServerHttpSecurity}.
28862886
* @return the {@link HeaderSpec} to continue configuring
2887-
* @deprecated For removal in 7.0. Use {@link #featurePolicy(Customizer)}
2888-
* instead
2887+
* @deprecated For removal in 7.0. Use {@link #featurePolicy(String)} instead
28892888
*/
28902889
@Deprecated(since = "6.1", forRemoval = true)
28912890
public HeaderSpec and() {
@@ -2898,7 +2897,7 @@ public HeaderSpec and() {
28982897
* Configures {@code Permissions-Policy} response header.
28992898
*
29002899
* @since 5.5
2901-
* @see #permissionsPolicy()
2900+
* @see HeaderSpec#permissionsPolicy(Customizer)
29022901
*/
29032902
public final class PermissionsPolicySpec {
29042903

@@ -2921,8 +2920,7 @@ public PermissionsPolicySpec policy(String policy) {
29212920
* Configures {@code Referrer-Policy} response header.
29222921
*
29232922
* @since 5.1
2924-
* @see #referrerPolicy()
2925-
* @see #referrerPolicy(ReferrerPolicy)
2923+
* @see HeaderSpec#referrerPolicy(Customizer)
29262924
*/
29272925
public final class ReferrerPolicySpec {
29282926

0 commit comments

Comments
 (0)