René's URL Explorer Experiment


Title: Keep a javadoc {@snippet} as it is written by abashev · Pull Request #75 · openjavaformat/open-java-format · GitHub

Open Graph Title: Keep a javadoc {@snippet} as it is written by abashev · Pull Request #75 · openjavaformat/open-java-format

X Title: Keep a javadoc {@snippet} as it is written by abashev · Pull Request #75 · openjavaformat/open-java-format

Description: Brings over google/google-java-format#1141, a fix from google-java-format 1.24. The bug With javadoc formatting on (JavaFormatterOptions.formatJavadoc(true)), the lines of a {@snippet ...} tag were reflowed like prose: /** * Example usage: * *

{@snippet : int x = 1; foo(x, y); // keep this } * *

Done. */ The code inside came out on one line,

in front of it, and a // comment in the snippet swallowed the closing brace. The lexer treated the snippet as any other inline tag, whose contents are joined and wrapped. From upstream, with the author kept google/google-java-format#1141 by cpovirk (Chris Povirk), commit authored by them: {@snippet that starts an inline tag is its own token, everything up to its closing brace keeps its newlines and spaces as inside

, and the writer puts a blank line before and after the snippet. Nothing inside the snippet is reformatted. The tests blankLinesAroundSnippetAndNoMangling and notASnippetUnlessOuterTag come with it.
Adapted to this lexer, which keeps inline tags as INLINE_TAG_OPEN and INLINE_TAG_CLOSE tokens (palantir#125): a {@snippet inside another inline tag is an ordinary inline tag here, as upstream's is an ordinary literal.

Added here

snippetKeepsCommentsAndIndentation: a snippet with indented code and a // @highlight markup comment stays exactly as written.

Checked

The three tests fail on main and pass with the change.
./gradlew :open-java-format:test on JDK 21: 1500 tests, all green.
Javadoc formatting is off unless JavaFormatterOptions asks for it, and the lexer only runs then, so the default output and the JDK corpus are unchanged by construction.

Open Graph Description: Brings over google/google-java-format#1141, a fix from google-java-format 1.24. The bug With javadoc formatting on (JavaFormatterOptions.formatJavadoc(true)), the lines of a {@snippet ...} tag were...

X Description: Brings over google/google-java-format#1141, a fix from google-java-format 1.24. The bug With javadoc formatting on (JavaFormatterOptions.formatJavadoc(true)), the lines of a {@snippet ...} tag were...

Opengraph URL: https://github.com/openjavaformat/open-java-format/pull/75

X: @github

direct link

Domain: github.com

react-profiling0
react-import-mapreact,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322
route-pattern/:user_id/:repository/pull/:id/files(.:format)
route-controllerpull_requests
route-actionfiles
fetch-noncev2:d9f0cce5-090f-18b8-0b2a-be036ddc9773
current-catalog-service-hashae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b
request-idB826:C3DCC:46A1D:60B27:6AFBC672
html-safe-nonce6a40c6a80e3adac4f459af9ef353f9e5e4f0f5d005d2fdcfc59ce1103436cedc
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCODI2OkMzRENDOjQ2QTFEOjYwQjI3OjZBRkJDNjcyIiwidmlzaXRvcl9pZCI6IjYzNjk2MDk3MzA2Nzg4MzQ4MDIiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ==
visitor-hmac3f1c836b38b8cb1cd0e0f5f809b9f99063eed42b130725d0d00783cabebc377c
hovercard-subject-tagpull_request:4630643027
github-keyboard-shortcutsrepository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///pull_requests/show/files
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/openjavaformat/open-java-format/pull/75/files
twitter:imagehttps://avatars.githubusercontent.com/u/214171?s=400&v=4
twitter:cardsummary_large_image
og:imagehttps://avatars.githubusercontent.com/u/214171?s=400&v=4
og:image:altBrings over google/google-java-format#1141, a fix from google-java-format 1.24. The bug With javadoc formatting on (JavaFormatterOptions.formatJavadoc(true)), the lines of a {@snippet ...} tag were...
og:site_nameGitHub
og:typeobject
hostnamegithub.com
expected-hostnamegithub.com
Noned440bda0d812801778b27bfe9f7c1ce9ff22420c73f6f95150c4fcbca311c50b
turbo-cache-controlno-preview
diff-viewunified
go-importgithub.com/openjavaformat/open-java-format git https://github.com/openjavaformat/open-java-format.git
octolytics-dimension-user_id325177626
octolytics-dimension-user_loginopenjavaformat
octolytics-dimension-repository_id1288055459
octolytics-dimension-repository_nwoopenjavaformat/open-java-format
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forktrue
octolytics-dimension-repository_parent_id214273098
octolytics-dimension-repository_parent_nwopalantir/palantir-java-format
octolytics-dimension-repository_network_root_id214273098
octolytics-dimension-repository_network_root_nwopalantir/palantir-java-format
turbo-body-classeslogged-out env-production page-responsive full-width
disable-turbotrue
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release2c43021aed8695990c86c0eaaedc600bfeffec36
ui-targetfull
theme-color#1e2327
color-schemelight dark

Links:

Skip to contenthttps://github.com/openjavaformat/open-java-format/pull/75/files#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fopenjavaformat%2Fopen-java-format%2Fpull%2F75%2Ffiles
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fopenjavaformat%2Fopen-java-format%2Fpull%2F75%2Ffiles
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fpull_requests%2Fshow%2Ffiles&source=header-repo&source_repo=openjavaformat%2Fopen-java-format
Reloadhttps://github.com/openjavaformat/open-java-format/pull/75/files
Reloadhttps://github.com/openjavaformat/open-java-format/pull/75/files
Reloadhttps://github.com/openjavaformat/open-java-format/pull/75/files
openjavaformathttps://github.com/openjavaformat
open-java-formathttps://github.com/openjavaformat/open-java-format
Codehttps://github.com/openjavaformat/open-java-format
Issues30 (30)https://github.com/openjavaformat/open-java-format/issues
Pull requests5 (5)https://github.com/openjavaformat/open-java-format/pulls
Discussionshttps://github.com/openjavaformat/open-java-format/discussions
Actionshttps://github.com/openjavaformat/open-java-format/actions
Security and qualityhttps://github.com/openjavaformat/open-java-format/security
Insightshttps://github.com/openjavaformat/open-java-format/pulse
Sign up for GitHub https://github.com/signup?return_to=%2Fopenjavaformat%2Fopen-java-format%2Fissues%2Fnew%2Fchoose
terms of servicehttps://docs.github.com/terms
privacy statementhttps://docs.github.com/privacy
Sign inhttps://github.com/login?return_to=%2Fopenjavaformat%2Fopen-java-format%2Fissues%2Fnew%2Fchoose
abashevhttps://github.com/abashev
mainhttps://github.com/openjavaformat/open-java-format/tree/main
javadoc-snippethttps://github.com/openjavaformat/open-java-format/tree/javadoc-snippet
Conversation 0 https://github.com/openjavaformat/open-java-format/pull/75
Commits 1 https://github.com/openjavaformat/open-java-format/pull/75/commits
Checks 15 https://github.com/openjavaformat/open-java-format/pull/75/checks
Files changed https://github.com/openjavaformat/open-java-format/pull/75/files
Please reload this pagehttps://github.com/openjavaformat/open-java-format/pull/75/files
Keep a javadoc {@snippet} as it is written https://github.com/openjavaformat/open-java-format/pull/75/files#top
Show all changes 1 commit https://github.com/openjavaformat/open-java-format/pull/75/files
eb20cda Keep a javadoc {@snippet} as it is written cpovirk Sep 24, 2026 https://github.com/openjavaformat/open-java-format/pull/75/commits/eb20cda065b0ac8b82ebe33e776e1987931b99ac
Clear filters https://github.com/openjavaformat/open-java-format/pull/75/files
Please reload this pagehttps://github.com/openjavaformat/open-java-format/pull/75/files
Please reload this pagehttps://github.com/openjavaformat/open-java-format/pull/75/files
JavadocFormatter.java https://github.com/openjavaformat/open-java-format/pull/75/files#diff-3fed08a12d2193e142ba3ffade9f7874fb27a933e7a1e040e33c95ad6102122b
JavadocLexer.java https://github.com/openjavaformat/open-java-format/pull/75/files#diff-4c525c8e93024d87ee499da472179e93fffbacc0075473d0ae40b09d959d1c40
JavadocWriter.java https://github.com/openjavaformat/open-java-format/pull/75/files#diff-de4a419665098250349ae1bf84b759c76ddafdc46bb5bc7b23f2e89fafcebab1
Token.java https://github.com/openjavaformat/open-java-format/pull/75/files#diff-78c5c0f693a71e3510d1b59522348bb41bfdcecd66dd47d753e64f10453e433f
JavadocFormattingTest.java https://github.com/openjavaformat/open-java-format/pull/75/files#diff-4874ab5903495ab1f5c86d1252ac208a672e524d979f7a6f5337a773b49b54f6
open-java-format/src/main/java/com/palantir/javaformat/java/javadoc/JavadocFormatter.javahttps://github.com/openjavaformat/open-java-format/pull/75/files#diff-3fed08a12d2193e142ba3ffade9f7874fb27a933e7a1e040e33c95ad6102122b
View file https://github.com/openjavaformat/open-java-format/blob/eb20cda065b0ac8b82ebe33e776e1987931b99ac/open-java-format/src/main/java/com/palantir/javaformat/java/javadoc/JavadocFormatter.java
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/openjavaformat/open-java-format/pull/75/{{ revealButtonHref }}
https://github.com/openjavaformat/open-java-format/pull/75/files#diff-3fed08a12d2193e142ba3ffade9f7874fb27a933e7a1e040e33c95ad6102122b
https://github.com/openjavaformat/open-java-format/pull/75/files#diff-3fed08a12d2193e142ba3ffade9f7874fb27a933e7a1e040e33c95ad6102122b
open-java-format/src/main/java/com/palantir/javaformat/java/javadoc/JavadocLexer.javahttps://github.com/openjavaformat/open-java-format/pull/75/files#diff-4c525c8e93024d87ee499da472179e93fffbacc0075473d0ae40b09d959d1c40
View file https://github.com/openjavaformat/open-java-format/blob/eb20cda065b0ac8b82ebe33e776e1987931b99ac/open-java-format/src/main/java/com/palantir/javaformat/java/javadoc/JavadocLexer.java
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/openjavaformat/open-java-format/pull/75/{{ revealButtonHref }}
https://github.com/openjavaformat/open-java-format/pull/75/files#diff-4c525c8e93024d87ee499da472179e93fffbacc0075473d0ae40b09d959d1c40
https://github.com/openjavaformat/open-java-format/pull/75/files#diff-4c525c8e93024d87ee499da472179e93fffbacc0075473d0ae40b09d959d1c40
https://github.com/openjavaformat/open-java-format/pull/75/files#diff-4c525c8e93024d87ee499da472179e93fffbacc0075473d0ae40b09d959d1c40
https://github.com/openjavaformat/open-java-format/pull/75/files#diff-4c525c8e93024d87ee499da472179e93fffbacc0075473d0ae40b09d959d1c40
https://github.com/openjavaformat/open-java-format/pull/75/files#diff-4c525c8e93024d87ee499da472179e93fffbacc0075473d0ae40b09d959d1c40
https://github.com/openjavaformat/open-java-format/pull/75/files#diff-4c525c8e93024d87ee499da472179e93fffbacc0075473d0ae40b09d959d1c40
https://github.com/openjavaformat/open-java-format/pull/75/files#diff-4c525c8e93024d87ee499da472179e93fffbacc0075473d0ae40b09d959d1c40
https://github.com/openjavaformat/open-java-format/pull/75/files#diff-4c525c8e93024d87ee499da472179e93fffbacc0075473d0ae40b09d959d1c40
https://github.com/openjavaformat/open-java-format/pull/75/files#diff-4c525c8e93024d87ee499da472179e93fffbacc0075473d0ae40b09d959d1c40
https://github.com/openjavaformat/open-java-format/pull/75/files#diff-4c525c8e93024d87ee499da472179e93fffbacc0075473d0ae40b09d959d1c40
open-java-format/src/main/java/com/palantir/javaformat/java/javadoc/JavadocWriter.javahttps://github.com/openjavaformat/open-java-format/pull/75/files#diff-de4a419665098250349ae1bf84b759c76ddafdc46bb5bc7b23f2e89fafcebab1
View file https://github.com/openjavaformat/open-java-format/blob/eb20cda065b0ac8b82ebe33e776e1987931b99ac/open-java-format/src/main/java/com/palantir/javaformat/java/javadoc/JavadocWriter.java
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/openjavaformat/open-java-format/pull/75/{{ revealButtonHref }}
https://github.com/openjavaformat/open-java-format/pull/75/files#diff-de4a419665098250349ae1bf84b759c76ddafdc46bb5bc7b23f2e89fafcebab1
https://github.com/openjavaformat/open-java-format/pull/75/files#diff-de4a419665098250349ae1bf84b759c76ddafdc46bb5bc7b23f2e89fafcebab1
open-java-format/src/main/java/com/palantir/javaformat/java/javadoc/Token.javahttps://github.com/openjavaformat/open-java-format/pull/75/files#diff-78c5c0f693a71e3510d1b59522348bb41bfdcecd66dd47d753e64f10453e433f
View file https://github.com/openjavaformat/open-java-format/blob/eb20cda065b0ac8b82ebe33e776e1987931b99ac/open-java-format/src/main/java/com/palantir/javaformat/java/javadoc/Token.java
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/openjavaformat/open-java-format/pull/75/{{ revealButtonHref }}
https://github.com/openjavaformat/open-java-format/pull/75/files#diff-78c5c0f693a71e3510d1b59522348bb41bfdcecd66dd47d753e64f10453e433f
https://github.com/openjavaformat/open-java-format/pull/75/files#diff-78c5c0f693a71e3510d1b59522348bb41bfdcecd66dd47d753e64f10453e433f
open-java-format/src/test/java/com/palantir/javaformat/java/JavadocFormattingTest.javahttps://github.com/openjavaformat/open-java-format/pull/75/files#diff-4874ab5903495ab1f5c86d1252ac208a672e524d979f7a6f5337a773b49b54f6
View file https://github.com/openjavaformat/open-java-format/blob/eb20cda065b0ac8b82ebe33e776e1987931b99ac/open-java-format/src/test/java/com/palantir/javaformat/java/JavadocFormattingTest.java
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/openjavaformat/open-java-format/pull/75/{{ revealButtonHref }}
https://github.com/openjavaformat/open-java-format/pull/75/files#diff-4874ab5903495ab1f5c86d1252ac208a672e524d979f7a6f5337a773b49b54f6
Please reload this pagehttps://github.com/openjavaformat/open-java-format/pull/75/files
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.