Skip to content

Commit e5b934d

Browse files
chanjin23rwinch
authored andcommitted
Core: Remove javadoc warnings
Closes gh-18449 Signed-off-by: chanjin-lee <chanjin23@naver.com>
1 parent e3f1690 commit e5b934d

6 files changed

Lines changed: 8 additions & 7 deletions

File tree

core/spring-security-core.gradle

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import java.util.concurrent.Callable
22

33
plugins {
4+
id 'javadoc-warnings-error'
45
id 'security-nullability'
56
}
67

core/src/main/java/org/springframework/security/access/hierarchicalroles/RoleHierarchyUtils.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,14 @@ private RoleHierarchyUtils() {
3636

3737
/**
3838
* Converts the supplied {@link Map} of role name to implied role name(s) to a string
39-
* representation understood by {@link RoleHierarchyImpl#setHierarchy(String)}. The
39+
* representation understood by {@code RoleHierarchyImpl#setHierarchy(String)}. The
4040
* map key is the role name and the map value is a {@link List} of implied role
4141
* name(s).
4242
* @param roleHierarchyMap the mapping(s) of role name to implied role name(s)
4343
* @return a string representation of a role hierarchy
4444
* @throws IllegalArgumentException if roleHierarchyMap is null or empty or if a role
4545
* name is null or empty or if an implied role name(s) is null or empty
46-
* @deprecated please see {@link RoleHierarchyImpl#setHierarchy} deprecation notice
46+
* @deprecated please see {@code RoleHierarchyImpl#setHierarchy} deprecation notice
4747
*/
4848
@Deprecated
4949
public static String roleHierarchyFromMap(Map<String, List<String>> roleHierarchyMap) {

core/src/main/java/org/springframework/security/access/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
* Core access-control related code, including security metadata related classes,
1919
* interception code, access control annotations, EL support and voter-based
2020
* implementations of the central
21-
* {@link org.springframework.security.access.AccessDecisionManager AccessDecisionManager}
21+
* {@code AccessDecisionManager}
2222
* interface.
2323
*/
2424
@NullMarked

core/src/main/java/org/springframework/security/authentication/AuthenticationTrustResolver.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ default boolean isFullyAuthenticated(@Nullable Authentication authentication) {
7777
* Checks if the {@link Authentication} is not null, authenticated, and not anonymous.
7878
* @param authentication the {@link Authentication} to check.
7979
* @return true if the {@link Authentication} is not null,
80-
* {@link #isAnonymous(Authentication)} returns false, &
80+
* {@link #isAnonymous(Authentication)} returns false, and
8181
* {@link Authentication#isAuthenticated()} is true.
8282
* @since 6.1.7
8383
*/

core/src/main/java/org/springframework/security/core/SpringSecurityCoreVersion.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ public final class SpringSecurityCoreVersion {
4242
/**
4343
* Global Serialization value for Spring Security classes.
4444
* @deprecated Please have each class use its own serialization version
45-
* @see SpringSecurityCoreVersionSerializableTests
45+
* For more details, refer to the {@code SpringSecurityCoreVersionSerializableTests} class.
4646
*/
4747
@Deprecated(forRemoval = true)
4848
public static final long SERIAL_VERSION_UID = 620L;

core/src/main/java/org/springframework/security/core/annotation/SecurityAnnotationScanner.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,9 @@ public interface SecurityAnnotationScanner<A extends Annotation> {
7272
* attributable to the parameter.
7373
*
7474
* <p>
75-
* Implementations should describe their strategy for searching the element and any
75+
* Implementations should describe their strategy for searching the parameter and any
7676
* surrounding class, interfaces, or super-class.
77-
* @param element the element to search
77+
* @param parameter the parameter to search
7878
* @return the synthesized annotation or {@code null} if not found
7979
*/
8080
@Nullable A scan(Parameter parameter);

0 commit comments

Comments
 (0)