Skip to content

Fix invalid javadoc reference on the remote flag in SpanContext - #8694

Draft
thswlsqls wants to merge 1 commit into
open-telemetry:mainfrom
thswlsqls:docs/span-context-remote-flag-javadoc
Draft

Fix invalid javadoc reference on the remote flag in SpanContext#8694
thswlsqls wants to merge 1 commit into
open-telemetry:mainfrom
thswlsqls:docs/span-context-remote-flag-javadoc

Conversation

@thswlsqls

Copy link
Copy Markdown
Contributor

No issue: trivial javadoc markup fix, issue not required (same as #8588).

Description

  • The SpanContext class javadoc links {@link boolean remote}, but boolean is a primitive type, so javadoc cannot resolve the reference.
  • The generated SpanContext.html renders a collapsed invalid reference block instead of "the remote flag".
  • Replace it with {@code remote}, matching how this file already refers to values rather than types. The neighbouring {@link TraceState traceState} resolves fine and is left as is.
  • -Xdoclint:all,-missing does not flag this case, so the build stays green while the published javadoc keeps the broken widget.
  • This is the only place in the repo that links a primitive type.

Testing done

  • Javadoc-only change, test-exempt: no test added.
  • ./gradlew :api:all:check passed.
  • ./gradlew :api:all:javadoc --rerun-tasks: SpanContext.html no longer contains invalid-tag; the sentence renders as "the remote flag".
  • No public API change, so the apidiff file is unchanged.
  • Not run: *IT and GraalVM native-image tests (outside check).

@codecov

codecov Bot commented Aug 5, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.62%. Comparing base (dd811c4) to head (4148ccf).

Additional details and impacted files
@@            Coverage Diff            @@
##               main    #8694   +/-   ##
=========================================
  Coverage     91.62%   91.62%           
  Complexity    10327    10327           
=========================================
  Files          1003     1003           
  Lines         27138    27138           
  Branches       3187     3187           
=========================================
  Hits          24866    24866           
  Misses         1566     1566           
  Partials        706      706           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant