docs(scala): fully-qualify ScalaDoc @throws and link references#4671
Merged
Conversation
Resolve 29+ scaladoc broken-link warnings by replacing bare class names in @throws tags and [[X]] inline links with their fully- qualified names. JDK exceptions go to java.lang/java.io/java.util/ java.sql; project-internal types use their full package + companion object path. AWS SDK references in S3StorageClient switch from Javadoc {@link X} to Scaladoc [[X]] form. Vendored JsonSchemaInject.java gains explicit class context on its method links. Closes apache#4670. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4671 +/- ##
============================================
+ Coverage 52.46% 53.02% +0.55%
- Complexity 0 1994 +1994
============================================
Files 353 817 +464
Lines 21338 24630 +3292
Branches 1791 1921 +130
============================================
+ Hits 11195 13060 +1865
- Misses 10026 10914 +888
- Partials 117 656 +539
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 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.
What changes were proposed in this PR?
Resolve the ScalaDoc broken-link warnings tracked in #4670 by replacing bare class names with fully-qualified names in
@throwstags and[[X]]inline links.java.lang.AssertionError,java.util.NoSuchElementException,java.lang.IllegalArgumentException,java.io.FileNotFoundException,java.lang.Exception,java.sql.SQLException,java.lang.reflect.AnnotatedType.javax.ws.rs.BadRequestException.org.apache.texera.amber.core.tuple.AttributeTypeUtils.AttributeTypeException,org.apache.texera.service.resource.ComputingUnitManagingResource.DashboardWorkflowComputingUnit.S3StorageClient.scala— Javadoc{@link software.amazon.awssdk...}references converted to ScalaDoc[[software.amazon.awssdk...]]form (the AWS SDK references are already on the classpath; ScalaDoc was rejecting the Javadoc syntax).JsonSchemaInject.java— same-class method links{@link #json()}rewritten with explicit class context as{@link JsonSchemaInject#json()}.@throws[X]annotations in code (Scala-level annotations, not docstring tags) are intentionally untouched — only the ScalaDoc* @throws Xlines and[[X]]references in comments change.Two extra docstring sites were swept up while at it (
StableMergeSortOpExecSpec.scala,DatasetResource.scala) so the build does not start emitting new warnings the next time their modules' scaladoc runs.Any related issues, documentation, discussions?
Closes #4670.
How was this PR tested?
Pure ScalaDoc / comment changes — no behavioral effect, no test changes. Verified by:
Was this PR authored or co-authored using generative AI tooling?
Generated-by: Claude Code (Opus 4.7, 1M context)