Render API doc markdown as native Javadoc HTML in doc comments#828
Draft
tanmay-db wants to merge 1 commit into
Draft
Render API doc markdown as native Javadoc HTML in doc comments#828tanmay-db wants to merge 1 commit into
tanmay-db wants to merge 1 commit into
Conversation
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
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
Contributor
|
If integration tests don't run automatically, an authorized user can run them manually by following the instructions below: Trigger: Inputs:
Checks will be approved automatically on success. |
Contributor
|
Please ensure that the NEXT_CHANGELOG.md file is updated with any relevant changes. |
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.
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:
when hazardous){@code ...}(escaped/
with- (previously broken by word-wrap, leaving list markers dangling mid-line)
- bold/italic -> /; &, <, >, */ 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
placement as Spotless).
Co-authored-by: Isaac
Summary
Why
What changed
Interface changes
Behavioral changes
Internal changes
How is this tested?