Skip to content

HBASE-30235 Fix Javadoc syntax errors#8376

Merged
guluo2016 merged 1 commit into
apache:masterfrom
gianmarcoschifone:fix-javadoc-parser-errors
Jun 25, 2026
Merged

HBASE-30235 Fix Javadoc syntax errors#8376
guluo2016 merged 1 commit into
apache:masterfrom
gianmarcoschifone:fix-javadoc-parser-errors

Conversation

@gianmarcoschifone

Copy link
Copy Markdown
Contributor

Fix Javadoc syntax errors reported by the JDK javadoc tool.

This updates malformed Javadoc in a few comments by escaping raw <...> text with {@code ...} and converting a raw @see URL to a valid link.

Validated with javadoc -Xdoclint:syntax on the affected files.

@liuxiaocs7

Copy link
Copy Markdown
Member

Hi, @gianmarcoschifone, please refer the doc(https://hbase.apache.org/docs/building-and-developing/developer-guidelines#commit) to update the commit msg and PR title, thanks!

@gianmarcoschifone

Copy link
Copy Markdown
Contributor Author

@liuxiaocs7 I'm not sure there is a relevant issue about this, should I create a new issue?

@romani

romani commented Jun 18, 2026

Copy link
Copy Markdown

@gianmarcoschifone
Please create quick issue HBASE-XXXX in their Jira tracker system. And reference in commit as prefix.

@gianmarcoschifone

Copy link
Copy Markdown
Contributor Author

@gianmarcoschifone Please create quick issue HBASE-XXXX in their Jira tracker system. And reference in commit as prefix.

@romani I will request an account on Jira, it will need some sort of approval

@gianmarcoschifone gianmarcoschifone force-pushed the fix-javadoc-parser-errors branch from d836b54 to 9c8822d Compare June 18, 2026 15:23
@gianmarcoschifone gianmarcoschifone changed the title Fix Javadoc syntax errors HBASE-30235 Fix Javadoc syntax errors Jun 18, 2026
@gianmarcoschifone

Copy link
Copy Markdown
Contributor Author

@liuxiaocs7 Done, thank you for guidance

@PDavid PDavid left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Many thanks, nice, clean and minimal fix. Looks good to me. 👍

@PDavid

PDavid commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

We have a code format checker (spotless) in the project which now found some formatting issue:s

patch has 23 errors when running spotless:check, run spotless:apply to fix.

See: https://github.com/apache/hbase/actions/runs/27770162291?pr=8376

Can you please run mvn spotless:apply to format all files and commit the changes?

@gianmarcoschifone gianmarcoschifone force-pushed the fix-javadoc-parser-errors branch from 9c8822d to b14be20 Compare June 23, 2026 19:27
@gianmarcoschifone

Copy link
Copy Markdown
Contributor Author

@PDavid Done, amended the commit

@liuxiaocs7

Copy link
Copy Markdown
Member

Thanks @gianmarcoschifone and @PDavid, let's wait the CI green!

@guluo2016 guluo2016 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot!

@guluo2016

Copy link
Copy Markdown
Member

@gianmarcoschifone Thanks for your contribution, please raise PR for branch-2.

@PDavid

PDavid commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Congrats for your first contribution @gianmarcoschifone!

@gianmarcoschifone

Copy link
Copy Markdown
Contributor Author

please raise PR for branch-2

@guluo2016 done, #8415

@guluo2016 guluo2016 merged commit 3332550 into apache:master Jun 25, 2026
15 of 18 checks passed
guluo2016 pushed a commit that referenced this pull request Jun 25, 2026
Signed-off-by: Dávid Paksy <paksyd@apache.org>
Signed-off-by: Pankaj Kumar <pankajkumar@apache.org>
Reviewed-by: Liu Xiao <liuxiao2103@qq.com>
Signed-off-by: Peng Lu <lupeng@apache.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants