Skip to content

Fix #2327: Correct @see tag usage in CircuitBreakerConfig Javadoc#2400

Merged
RobWin merged 1 commit intoresilience4j:masterfrom
chanani:fix/issue-2327-javadoc-link
Feb 24, 2026
Merged

Fix #2327: Correct @see tag usage in CircuitBreakerConfig Javadoc#2400
RobWin merged 1 commit intoresilience4j:masterfrom
chanani:fix/issue-2327-javadoc-link

Conversation

@chanani
Copy link
Copy Markdown
Contributor

@chanani chanani commented Jan 23, 2026

Description

Fixes #2327

Corrects improper @see tag usage in CircuitBreakerConfig.java to fix Javadoc rendering in IDEs.

Changes

  • Moved @see tags to correct position (after @param and @return)
  • Removed descriptive text from @see tags (moved to method description)
  • Affected methods: recordExceptions() and ignoreExceptions()

Before:

* @return the CircuitBreakerConfig.Builder
* @see #ignoreExceptions(Class[]) ). Ignoring an exception has priority...

After:

* @param errorClasses the error classes that are recorded
* @return the CircuitBreakerConfig.Builder
* @see #ignoreExceptions(Class[])
issue_2327

Testing

  • ./gradlew javadoc - builds successfully
  • Verified rendering in IntelliJ IDEA

@chanani
Fix resilience4j#2327: Correct @see tag placement in CircuitBreakerCo…
3cbe291 
…nfig Javadoc

Move @see tags to proper position after @param/@return and remove
descriptive text from @see tags for proper IDE rendering.
@dosubot dosubot Bot added size:S This PR changes 10-29 lines, ignoring generated files. documentation update labels Jan 23, 2026
@chanani chanani mentioned this pull request Jan 23, 2026
Closed
@chanani
Copy link
Copy Markdown
Contributor Author

chanani commented Feb 9, 2026

Hi @RobWin ! Just checking in to see if someone could take a look at this when you have a moment. Thanks!

@RobWin RobWin merged commit bba72f6 into resilience4j:master Feb 24, 2026
2 checks passed
@chanani chanani deleted the fix/issue-2327-javadoc-link branch February 24, 2026 11:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

documentation update size:S This PR changes 10-29 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

CircuitBreakerConfig.java - Javadoc should use @link to refer to other methods instead of @see

2 participants

@chanani @RobWin