Skip to content

Commit ad1d858

Browse files
thomasdarimontRob Winch
authored andcommitted
SEC-3056 - Fix JavaDoc errors.
Fixed JavaDoc errors accross multiple modules in order to make javadoc happy with Java 8.
1 parent 7317c09 commit ad1d858

File tree

84 files changed

+235
-268
lines changed

Some content is hidden

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

84 files changed

+235
-268
lines changed

acl/src/main/java/org/springframework/security/acls/AclEntryVoter.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,14 +83,14 @@
8383
* Alternatively, you could have used a common superclass or interface for the
8484
* {@link #processDomainObjectClass} if both <code>BankAccount</code> and
8585
* <code>Customer</code> had common parents.
86-
* </p>
86+
*
8787
* <p>
8888
* If the principal does not have sufficient permissions, the voter will vote to deny
8989
* access.
90-
* </p>
90+
*
9191
* <p>
9292
* All comparisons and prefixes are case sensitive.
93-
* </p>
93+
*
9494
*
9595
* @author Ben Alex
9696
*/

config/src/main/java/org/springframework/security/config/annotation/SecurityConfigurerAdapter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ public B and() {
5858
* Gets the {@link SecurityBuilder}. Cannot be null.
5959
*
6060
* @return the {@link SecurityBuilder}
61-
* @throw {@link IllegalStateException} if {@link SecurityBuilder} is null
61+
* @throws IllegalStateException if {@link SecurityBuilder} is null
6262
*/
6363
protected final B getBuilder() {
6464
if (securityBuilder == null) {

config/src/main/java/org/springframework/security/config/annotation/authentication/ProviderManagerBuilder.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,10 @@ public interface ProviderManagerBuilder<B extends ProviderManagerBuilder<B>> ext
3636
* customizations must be done externally and the {@link ProviderManagerBuilder} is
3737
* returned immediately.
3838
*
39+
* Note that an Exception is thrown if an error occurs when adding the {@link AuthenticationProvider}.
40+
*
3941
* @return a {@link ProviderManagerBuilder} to allow further authentication to be
4042
* provided to the {@link ProviderManagerBuilder}
41-
* @throws Exception if an error occurs when adding the {@link AuthenticationProvider}
4243
*/
4344
B authenticationProvider(AuthenticationProvider authenticationProvider);
4445
}

config/src/main/java/org/springframework/security/config/annotation/authentication/builders/AuthenticationManagerBuilder.java

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ public class AuthenticationManagerBuilder
6161

6262
/**
6363
* Creates a new instance
64-
* @param the {@link ObjectPostProcessor} instance to use.
64+
* @param objectPostProcessor the {@link ObjectPostProcessor} instance to use.
6565
*/
6666
public AuthenticationManagerBuilder(ObjectPostProcessor<Object> objectPostProcessor) {
6767
super(objectPostProcessor, true);
@@ -196,7 +196,6 @@ public <T extends UserDetailsService> DaoAuthenticationConfigurer<Authentication
196196
* <p>
197197
* This method <b>does NOT</b> ensure that a {@link UserDetailsService} is available
198198
* for the {@link #getDefaultUserDetailsService()} method.
199-
* </p>
200199
*
201200
* @return a {@link LdapAuthenticationProviderConfigurer} to allow customization of
202201
* the LDAP authentication
@@ -216,11 +215,11 @@ public LdapAuthenticationProviderConfigurer<AuthenticationManagerBuilder> ldapAu
216215
* <p>
217216
* This method <b>does NOT</b> ensure that the {@link UserDetailsService} is available
218217
* for the {@link #getDefaultUserDetailsService()} method.
219-
* </p>
218+
*
219+
* Note that an {@link Exception} might be thrown if an error occurs when adding the {@link AuthenticationProvider}.
220220
*
221221
* @return a {@link AuthenticationManagerBuilder} to allow further authentication to
222222
* be provided to the {@link AuthenticationManagerBuilder}
223-
* @throws Exception if an error occurs when adding the {@link AuthenticationProvider}
224223
*/
225224
public AuthenticationManagerBuilder authenticationProvider(
226225
AuthenticationProvider authenticationProvider) {

config/src/main/java/org/springframework/security/config/annotation/authentication/configurers/provisioning/InMemoryUserDetailsManagerConfigurer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
* to have in memory authentication. It also allows easily adding users to the in memory
2828
* authentication.
2929
*
30-
* @param <B> the type of the {@link SecurityBuilder} that is being configured
30+
* @param <B> the type of the {@link ProviderManagerBuilder} that is being configured
3131
*
3232
* @author Rob Winch
3333
* @since 3.2

config/src/main/java/org/springframework/security/config/annotation/authentication/configurers/provisioning/JdbcUserDetailsManagerConfigurer.java

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@
3838
* <p>
3939
* The only required method is the {@link #dataSource(javax.sql.DataSource)} all other
4040
* methods have reasonable defaults.
41-
* </p>
4241
*
4342
* @param <B> the type of the {@link ProviderManagerBuilder} that is being configured
4443
*
@@ -82,7 +81,7 @@ public JdbcUserDetailsManagerConfigurer<B> dataSource(DataSource dataSource)
8281
* </code>
8382
* @param query The query to use for selecting the username, password, and if the user
8483
* is enabled by username. Must contain a single parameter for the username.
85-
* @return The {@link JdbcUserDetailsManagerRegistry} used for additional
84+
* @return The {@link JdbcUserDetailsManagerConfigurer} used for additional
8685
* customizations
8786
* @throws Exception
8887
*/
@@ -102,7 +101,7 @@ public JdbcUserDetailsManagerConfigurer<B> usersByUsernameQuery(String query)
102101
*
103102
* @param query The query to use for selecting the username, authority by username.
104103
* Must contain a single parameter for the username.
105-
* @return The {@link JdbcUserDetailsManagerRegistry} used for additional
104+
* @return The {@link JdbcUserDetailsManagerConfigurer} used for additional
106105
* customizations
107106
* @throws Exception
108107
*/
@@ -126,7 +125,7 @@ public JdbcUserDetailsManagerConfigurer<B> authoritiesByUsernameQuery(String que
126125
*
127126
* @param query The query to use for selecting the authorities by group. Must contain
128127
* a single parameter for the username.
129-
* @return The {@link JdbcUserDetailsManagerRegistry} used for additional
128+
* @return The {@link JdbcUserDetailsManagerConfigurer} used for additional
130129
* customizations
131130
* @throws Exception
132131
*/
@@ -181,7 +180,7 @@ public JdbcUserDetailsManager getUserDetailsService() {
181180
/**
182181
* Populates the default schema that allows users and authorities to be stored.
183182
*
184-
* @return The {@link JdbcUserDetailsManagerRegistry} used for additional
183+
* @return The {@link JdbcUserDetailsManagerConfigurer} used for additional
185184
* customizations
186185
*/
187186
public JdbcUserDetailsManagerConfigurer<B> withDefaultSchema() {

config/src/main/java/org/springframework/security/config/annotation/authentication/configurers/provisioning/UserDetailsManagerConfigurer.java

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -80,9 +80,6 @@ public final UserDetailsBuilder withUser(String username) {
8080
/**
8181
* Builds the user to be added. At minimum the username, password, and authorities
8282
* should provided. The remaining attributes have reasonable defaults.
83-
*
84-
* @param <T> the type of {@link UserDetailsManagerConfigurer} to return for chaining
85-
* methods.
8683
*/
8784
public class UserDetailsBuilder {
8885
private String username;
@@ -103,11 +100,10 @@ private UserDetailsBuilder(C builder) {
103100
}
104101

105102
/**
106-
* Returns the {@link UserDetailsManagerRegistry} for method chaining (i.e. to add
103+
* Returns the {@link UserDetailsManagerConfigurer} for method chaining (i.e. to add
107104
* another user)
108105
*
109-
* @return the {@link UserDetailsManagerRegistry} for method chaining (i.e. to add
110-
* another user)
106+
* @return the {@link UserDetailsManagerConfigurer} for method chaining
111107
*/
112108
public C and() {
113109
return builder;

config/src/main/java/org/springframework/security/config/annotation/authentication/configurers/userdetails/UserDetailsServiceConfigurer.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@
2727
* @author Rob Winch
2828
* @since 3.2
2929
*
30-
* @param <B> the type of the {@link SecurityBuilder}
31-
* @param <C> the {@link SecurityConfigurer} (or this)
30+
* @param <B> the type of the {@link ProviderManagerBuilder}
31+
* @param <C> the {@link UserDetailsServiceConfigurer} (or this)
3232
* @param <U> the type of UserDetailsService being used to allow for returning the
3333
* concrete UserDetailsService.
3434
*/

config/src/main/java/org/springframework/security/config/annotation/method/configuration/EnableGlobalMethodSecurity.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,8 @@
2929

3030
/**
3131
* <p>
32-
* Enables Spring Security global method security similar to the <global-method-security>
32+
* Enables Spring Security global method security similar to the &lt;global-method-security&gt;
3333
* xml support.
34-
* </p>
3534
*
3635
* <p>
3736
* More advanced configurations may wish to extend

config/src/main/java/org/springframework/security/config/annotation/web/HttpSecurityBuilder.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,11 +142,11 @@ <C extends SecurityConfigurer<DefaultSecurityFilterChain, H>> C removeConfigurer
142142
* <li>{@link LogoutFilter}</li>
143143
* <li>{@link X509AuthenticationFilter}</li>
144144
* <li>{@link AbstractPreAuthenticatedProcessingFilter}</li>
145-
* <li>{@link org.springframework.security.cas.web.CasAuthenticationFilter}</li>
145+
* <li><a href="{@docRoot}/org/springframework/security/cas/web/CasAuthenticationFilter.html">CasAuthenticationFilter</a></li>
146146
* <li>{@link UsernamePasswordAuthenticationFilter}</li>
147147
* <li>{@link ConcurrentSessionFilter}</li>
148148
* <li>{@link OpenIDAuthenticationFilter}</li>
149-
* <li>{@link DefaultLoginPageGeneratingFilter}</li>
149+
* <li>{@link org.springframework.security.web.authentication.ui.DefaultLoginPageGeneratingFilter}</li>
150150
* <li>{@link ConcurrentSessionFilter}</li>
151151
* <li>{@link DigestAuthenticationFilter}</li>
152152
* <li>{@link BasicAuthenticationFilter}</li>

0 commit comments

Comments
 (0)