Skip to content

Render API doc markdown as native Javadoc HTML in doc comments - #828

Draft
tanmay-db wants to merge 1 commit into
databricks:mainfrom
tanmay-db:docfmt-native-javadoc
Draft

tanmay-db wants to merge 1 commit into
databricks:mainfrom
tanmay-db:docfmt-native-javadoc

Conversation

@tanmay-db

Copy link
Copy Markdown
Contributor

Regenerated doc comments with genkit's new docfmt renderer, which parses spec descriptions as CommonMark and emits Javadoc-native HTML instead of leaking raw markdown:

Generated from the exact OpenAPI spec sha the SDK is pinned to (.codegen/_openapi_sha), so the diff is doc-comment-only: every changed line is inside a /** */ block, verified mechanically. Output formatted with google-java-format (same paragraph

placement as Spotless).

Co-authored-by: Isaac

Summary

Why

What changed

Interface changes

Behavioral changes

Internal changes

How is this tested?

Regenerated doc comments with genkit's new docfmt renderer, which
parses spec descriptions as CommonMark and emits Javadoc-native HTML
instead of leaking raw markdown:

- inline backticks -> {@code} (falls back to <code> when hazardous)
- fenced code examples -> <pre>{@code ...}</pre> (escaped <pre><code>
  for samples containing @ or unbalanced braces)
- markdown links -> <a href> anchors (reference-style links previously
  rendered as literal brackets with orphaned URL definitions)
- bullet/numbered lists -> <ul>/<ol> with <li> (previously broken by
  word-wrap, leaving list markers dangling mid-line)
- **bold**/_italic_ -> <b>/<i>; &, <, >, */ escaped for Javadoc

Generated from the exact OpenAPI spec sha the SDK is pinned to
(.codegen/_openapi_sha), so the diff is doc-comment-only: every changed
line is inside a /** */ block, verified mechanically. Output formatted
with google-java-format (same paragraph <p> placement as Spotless).

Co-authored-by: Isaac
@tanmay-db
tanmay-db temporarily deployed to test-trigger-is June 12, 2026 15:03 — with GitHub Actions Inactive
@github-actions

Copy link
Copy Markdown
Contributor

If integration tests don't run automatically, an authorized user can run them manually by following the instructions below:

Trigger:
go/deco-tests-run/sdk-java

Inputs:

  • PR number: 828
  • Commit SHA: d7fd346b814f5f4891460364b9457db5a0bdfaa5

Checks will be approved automatically on success.

@github-actions

Copy link
Copy Markdown
Contributor

Please ensure that the NEXT_CHANGELOG.md file is updated with any relevant changes.
If this is not necessary for your PR, please include the following in your PR description:
NO_CHANGELOG=true
and rerun the job.

This branch was previously deployed

1 inactive deployment
test-trigger-is — d7fd346b Deployed Jun 12, 2026 by tanmay-db via Check secrets access #1461
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