Skip to content

Use configuration key as link label - #2147

Merged
kwin merged 1 commit into
masterfrom
feature/fix-javadoc-link-label-for-configuration-fields
Sep 16, 2026
Merged

kwin merged 1 commit into
masterfrom
feature/fix-javadoc-link-label-for-configuration-fields

Conversation

@kwin

@kwin kwin commented Sep 15, 2026

Copy link
Copy Markdown
Member

The underlying field name is not-known and irrelevant to users. This closes #2146

Following this checklist to help us incorporate your
contribution quickly and easily:

  • Your pull request should address just one issue, without pulling in other changes.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Each commit in the pull request should have a meaningful subject line and body.
    Note that commits might be squashed by a maintainer on merge.
  • Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied.
    This may not always be possible but is a best-practice.
  • Run mvn verify to make sure basic checks pass.
    A more thorough check will be performed on your pull request automatically.
  • You have run the integration tests successfully (mvn -Prun-its verify).

If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.

To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

The underlying field name is not-known and irrelevant to users.
This closes #2146
@kwin
kwin requested review from cstamas and gnodet September 15, 2026 10:13
@kwin kwin added the documentation Improvements or additions to documentation label Sep 15, 2026

@gnodet-bot gnodet-bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Correct fix for the confusing link label issue (#2146).

The 3-line insertion into visitLink properly overrides rendered with the configuration key string before assembling the anchor, and correctly distinguishes {@link} (code-wrapped) from {@linkplain} (plain text) via the existing Kind check. The null guard and mode check are already in place. All three affected test assertions are updated consistently — description (inline {@link #STRING_KEY}), deprecated (inline {@link #ENUM2_KEY}), and the markdown rendering test.

This review was generated by an AI agent, Hermès on behalf of @gnodet.

@kwin
kwin merged commit a90b7f7 into master Sep 16, 2026
25 checks passed
@kwin
kwin deleted the feature/fix-javadoc-link-label-for-configuration-fields branch September 16, 2026 18:06
@github-actions github-actions Bot added this to the 2.0.24 milestone Sep 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve rendering of javadoc links to configuration fields in configuration

3 participants