Yicong-Huang opened a new pull request, #4671:
URL: https://github.com/apache/texera/pull/4671
### 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 `@throws` tags and `[[X]]` inline
links.
- JDK exception references → `java.lang.AssertionError`,
`java.util.NoSuchElementException`, `java.lang.IllegalArgumentException`,
`java.io.FileNotFoundException`, `java.lang.Exception`,
`java.sql.SQLException`, `java.lang.reflect.AnnotatedType`.
- JAX-RS exception → `javax.ws.rs.BadRequestException`.
- Project-internal references resolved against their companion objects:
`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).
- Vendored `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 X` lines 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:
1. \`grep -r '@throws AssertionError' --include='*.scala'\` and the same for
the other 8 bare class names returns zero hits across the repo.
2. CI's scala job runs scaladoc as part of \`sbt jacoco\` / compile and will
report any remaining unresolved references.
### Was this PR authored or co-authored using generative AI tooling?
Generated-by: Claude Code (Opus 4.7, 1M context)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
