Skip to content

Fix Javadoc warnings in spring-security-web#18473

Merged
rwinch merged 2 commits intospring-projects:mainfrom
Rigu1:fix/javadoc-warnings-web
Jan 12, 2026
Merged

Fix Javadoc warnings in spring-security-web#18473
rwinch merged 2 commits intospring-projects:mainfrom
Rigu1:fix/javadoc-warnings-web

Conversation

@Rigu1
Copy link
Copy Markdown
Contributor

@Rigu1 Rigu1 commented Jan 10, 2026

As the first PR addressing Javadoc warnings (gh-18443), this contribution fixes warnings in the spring-security-web module and implements the requested shared build plugin.

1. Fix Javadoc Warnings in spring-security-web

Resolved external reference warnings caused by Javadoc links by replacing @see and @link usages with inline <code> tags inDelegatingMissingAuthorityAccessDeniedHandler and SwitchUserWebFilter.

  • Fixed a typo in SessionAuthenticationException
    (ServerSessionAuthenticationStrategySessionAuthenticationStrategy).

2. New Build Plugin: javadoc-warnings-error

A new convention plugin has been added at
buildSrc/src/main/groovy/javadoc-warnings-error.groovy.

The plugin configures all Javadoc tasks to fail the build if any warning occurs (-Werror), preventing Javadoc warnings from being introduced in the future.

Usage in other modules

Other modules can enable this behavior by applying the plugin in their build.gradle:

plugins {
    id 'javadoc-warnings-error'
}

Closes gh-18468

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Jan 10, 2026
dasog94 added a commit to dasog94/spring-security that referenced this pull request Jan 12, 2026
- Fix a javadoc warning
- Apply plugin to configure Javadoc to fail on warnings
- Note: Based on pending changes in PR spring-projects#18473

Closes spring-projectsgh-18460

Signed-off-by: Jihong Bae <dasog94@gmail.com>
dasog94 pushed a commit to dasog94/spring-security that referenced this pull request Jan 12, 2026
- Fix a javadoc warning
- Apply plugin to configure Javadoc to fail on warnings
- Note: Based on pending changes in PR spring-projects#18473

Closes spring-projectsgh-18460

Signed-off-by: Bae Jihong <dasog@naver.com>
Copy link
Copy Markdown
Member

@rwinch rwinch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the PR. I've provided feedback inline

@rwinch rwinch self-assigned this Jan 12, 2026
@rwinch rwinch added in: build An issue in the build in: web An issue in web modules (web, webmvc) status: waiting-for-feedback We need additional information before we can continue and removed status: waiting-for-triage An issue we've not yet triaged labels Jan 12, 2026
@Rigu1 Rigu1 force-pushed the fix/javadoc-warnings-web branch from 92a0fa6 to 6da239e Compare January 12, 2026 18:55
Rigu1 added 2 commits January 13, 2026 04:05
Signed-off-by: rigu1 <dlsrbtla@gmail.com>
* Use <code> tags for external references in DelegatingMissingAuthorityAccessDeniedHandler and SwitchUserWebFilter
* Fix typo in SessionAuthenticationException
* Apply javadoc-warnings-error plugin

Closes spring-projectsgh-18468

Signed-off-by: rigu1 <dlsrbtla@gmail.com>
@Rigu1 Rigu1 force-pushed the fix/javadoc-warnings-web branch from 6da239e to b351b48 Compare January 12, 2026 19:05
@rwinch rwinch removed the status: waiting-for-feedback We need additional information before we can continue label Jan 12, 2026
@rwinch rwinch enabled auto-merge (rebase) January 12, 2026 19:11
@rwinch rwinch added this to the 7.0.3 milestone Jan 12, 2026
@rwinch
Copy link
Copy Markdown
Member

rwinch commented Jan 12, 2026

Thanks again for the PR @Rigu1! This is now scheduled to be merged into main upon the build completing successfully.

@rwinch rwinch added the type: enhancement A general enhancement label Jan 12, 2026
@rwinch rwinch merged commit 0a6883c into spring-projects:main Jan 12, 2026
6 checks passed
@Rigu1 Rigu1 deleted the fix/javadoc-warnings-web branch January 12, 2026 19:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

in: build An issue in the build in: web An issue in web modules (web, webmvc) type: enhancement A general enhancement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Remove javadoc warnings for spring-security-web

3 participants