Skip to content

fix(java): avoid javadoc doclint errors in cloud font loader comment - #199

Merged
shps951023 merged 1 commit into
mainfrom
fix/java-0.4.0-javadoc-comment
Sep 21, 2026
Merged

shps951023 merged 1 commit into
mainfrom
fix/java-0.4.0-javadoc-comment

Conversation

@shps951023

@shps951023 shps951023 commented Sep 21, 2026

Copy link
Copy Markdown
Member

The 0.4.0 release publish failed at the javadoc step of the release profile: the loadSystemFontByFamily javadoc contained Windows paths with backslash-escaped angle brackets (\\, \\) which doclint parses as unknown inline tags (2 errors). Rephrased the comment to avoid angle brackets.

Summary by CodeRabbit

  • Documentation
    • Clarified the documented location of Microsoft 365 cloud fonts in the system font cache.

The loadSystemFontByFamily javadoc contained Windows paths with
backslash-escaped angle brackets (\\<version>, \\<Family>), which the
release profile's javadoc step parses as unknown inline tags and fails
the build with two errors.
@coderabbitai

coderabbitai Bot commented Sep 21, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

Understand this PR’s impact

Explore downstream dependencies and potential security impact with Blast Radius.

View blast radius →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: ec350573-2825-44c5-8873-c6c1cec9d16a

📥 Commits

Reviewing files that changed from the base of the PR and between 6017f9b and 287ba21.

📒 Files selected for processing (1)
  • minipdf-java/minipdf/src/main/java/io/github/minisoftware/minipdf/internal/SimplePdfTextRenderer.java

Included review availability: Your plan provides up to 2 included reviews per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The pull request updates Javadoc for Microsoft 365 cloud font cache and Windows fonts paths. No code behavior or public declarations changed.

Changes

Font Cache Documentation

Layer / File(s) Summary
Update font cache path documentation
minipdf-java/minipdf/src/main/java/io/github/minisoftware/minipdf/internal/SimplePdfTextRenderer.java
The Javadoc now describes the %LOCALAPPDATA%/Microsoft/FontCache location, its CloudFonts family subfolder, and the Windows/Fonts path.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~2 minutes

Change: Other

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately identifies the Java Javadoc documentation fix and the doclint errors it prevents. It is concise and specific to the pull request changes.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

Comment @coderabbitai help to get the list of available commands.

@shps951023
shps951023 merged commit 31ec475 into main Sep 21, 2026
21 checks passed
@shps951023
shps951023 deleted the fix/java-0.4.0-javadoc-comment branch September 21, 2026 06:01
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.

1 participant