Fix Javadoc warnings in spring-security-core #18516
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
spring-projects-issues
added
the
status: waiting-for-triage
Closes spring-projectsgh-18449 Signed-off-by: chanjin-lee <chanjin23@naver.com>
chanjin23
force-pushed
the
gh-18449-core-javadoc
branch
from
914c1e5 to
69a57cd
Compare
- Update package-info to reference AuthorizationManager instead of AccessDecisionManager - Improve RoleHierarchyUtils documentation with fromHierarchy() and builder-based alternatives - Refine AuthenticationTrustResolver return description by removing redundant comma and symbol Signed-off-by: chanjin-lee <chanjin23@naver.com>
rwinch
added
in: docs
Fixes formatting for spring-projectsgh-18516
Member
|
Thanks for the pull request. It appears that it broke the checkstyle/formatting. It appears that I missed providing directions to run this check on the parent issue, so I've updated the parent issue to validate this before submitting PRs in the future. I've also pushed a fix to this PR. When the PR build passes, it will be merged. |
Member
|
Thanks again for your contribution @chanjin23 This is now merged into main! |
rwinch
added
in: build
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Following the initiative to address Javadoc warnings (gh-18443), this PR fixes multiple warnings in the spring-security-core module and applies the shared build plugin to enforce zero warnings.
RoleHierarchyUtils.java Updated the documentation to guide users toward modern alternatives. Replaced the deprecated manual conversion reference with a recommendation to use RoleHierarchyImpl#fromHierarchy(String) or the builder-based approach.
package-info.java (org.springframework.security.access) Reflected the modern authorization architecture by replacing the reference to the deprecated AccessDecisionManager with the central AuthorizationManager interface.
AuthenticationTrustResolver.java: Fixed an "invalid input: '&'" warning by replacing the raw & character with and in the isAuthenticated method's return description.
SecurityAnnotationScanner.java: Resolved a @param mismatch warning. Changed the parameter name and description from element to parameter to correctly align with the method signature scan(Parameter parameter).
SpringSecurityCoreVersion.java Fixed a "reference not found" warning for SpringSecurityCoreVersionSerializableTests. Since test classes are not on the main classpath, the problematic @see tag was replaced with a descriptive sentence using {@code} to maintain the reference without causing build-time errors.
Apply Build Plugin: javadoc-warnings-error
Applied the javadoc-warnings-error plugin to the spring-security-core build configuration. This ensures the build will fail if any Javadoc warning occurs, preventing warnings from being introduced in the future.
close #18445