Fix invalid javadoc reference on the remote flag in SpanContext - #8694
Draft
thswlsqls wants to merge 1 commit into
Draft
Fix invalid javadoc reference on the remote flag in SpanContext#8694thswlsqls wants to merge 1 commit into
thswlsqls wants to merge 1 commit into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No issue: trivial javadoc markup fix, issue not required (same as #8588).
Description
SpanContextclass javadoc links{@link boolean remote}, butbooleanis a primitive type, so javadoc cannot resolve the reference.SpanContext.htmlrenders a collapsedinvalid referenceblock instead of "theremoteflag".{@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,-missingdoes not flag this case, so the build stays green while the published javadoc keeps the broken widget.Testing done
./gradlew :api:all:checkpassed../gradlew :api:all:javadoc --rerun-tasks:SpanContext.htmlno longer containsinvalid-tag; the sentence renders as "theremoteflag".*ITand GraalVM native-image tests (outsidecheck).