fix(java): repair broken javadoc @link to disabled getRatings - #582
Merged
Conversation
The ratings-disable change (#562) commented out FundamentalContext.getRatings but left StockRatings' class javadoc referencing it via {@link FundamentalContext#getRatings}. javadoc's doclint treats the now-unresolvable reference as an error, breaking the check-java-sdk CI on main. Replace the broken @link with plain text noting the endpoint is temporarily disabled. Verified: mvn javadoc:javadoc now BUILD SUCCESS.
hogan-yuan
added a commit
that referenced
this pull request
Sep 1, 2026
## 问题 main 的 `check-format` CI 失败(#582 合并后触发的那次跑): ``` Diff in java/crates/macros/src/lib.rs:129 Diff in java/src/error.rs:90 ... ``` ## 根因 - `check-format` job 用 **未固定版本的 nightly**(`toolchain: nightly`)跑 `cargo fmt --all -- --check`; - `.rustfmt.toml` 开了 unstable 的 `wrap_comments = true`,其注释折行算法在近期 nightly 里变了; - 之前用旧 nightly 格式化过的注释,在新 nightly 下不再满足 `--check`。 跟 #582 无关(#582 只改了一个 `.java` 文件,cargo fmt 不处理 Java)—— 只是 #582 那次 push 触发了用新 nightly 的检查。 ## 修复 用当前 nightly(rustfmt 1.10.0-nightly, 2026-08-30)重排受影响文件的注释。**纯注释/空白,无任何代码逻辑改动**(已核对:非注释改动行为空)。 ## 验证 本地 `cargo +nightly fmt --all -- --check` → **exit 0、无 diff**。 > 备注:根因是 CI 用漂移的 nightly + unstable `wrap_comments`,以后 nightly 再变还会复发。若要彻底稳定,可考虑在 CI 固定 nightly 日期(如 `toolchain: nightly-2026-08-30`)——本 PR 未做此改动,留给维护者决定。 🤖 Generated with [Claude Code](https://claude.com/claude-code)
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.
问题
main 的 CI(check-java-sdk)失败:
ratings 暂不开放的下线改动(#562)把
FundamentalContext.getRatings注释掉了,但StockRatings的类级 javadoc 仍用{@link FundamentalContext#getRatings}引用它。javadoc 的 doclint 把这个无法解析的引用当作 error,导致 Java SDK 的 javadoc 构建失败。修复
把断链的
{@link}改成纯文本,说明该端点暂不开放、该类保留待接口重开。验证
本地
mvn javadoc:javadoc→ BUILD SUCCESS,无 reference-not-found。🤖 Generated with Claude Code