fix(java): repair broken javadoc @link to disabled getRatings - #582
Open
hogan-yuan wants to merge 1 commit into
Open
fix(java): repair broken javadoc @link to disabled getRatings#582hogan-yuan wants to merge 1 commit into
hogan-yuan wants to merge 1 commit into
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.
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
1 participant
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