Skip to content

docs(android): Fix Javadoc that Error Prone flags in sentry-android-core - #6498

Merged
runningcode merged 1 commit into
mainfrom
no/android-core-javadoc
Nov 10, 2026
Merged

runningcode merged 1 commit into
mainfrom
no/android-core-javadoc

Conversation

@runningcode

@runningcode runningcode commented Nov 6, 2026 •

Copy link
Copy Markdown
Contributor

📜 Description

Fixes the 34 Javadoc warnings Error Prone reports in sentry-android-core:

  • MissingSummary: turns the @return text into a "Returns ..." summary, and adds summaries to Javadocs that only had block tags.
  • InvalidBlockTag: replaces the @noinspection unused Javadoc tags with @SuppressWarnings("unused"), which IntelliJ honors too.
  • NotJavadoc: turns the Javadoc on methods of an anonymous class into regular comments.

💡 Motivation and Context

Error Prone never ran on sentry-android-core (#6493). Under -Werror these warnings fail the build once it does. This is one of four independent PRs that fix what it reports. It targets main because it changes no behavior or API; it reaches 9.x.x with the next merge from main.

💚 How did you test it?

Compiled with Error Prone enabled: none of these warnings remain and none are added.

📝 Checklist

  • I added GH Issue ID & Linear ID
  • I added tests to verify the changes.
  • No new PII added or SDK only sends newly added PII if sendDefaultPII is enabled.
  • I updated the docs if needed.
  • I updated the wizard if needed.
  • Review from the native team if needed.
  • No breaking change or entry added to the changelog.
  • No breaking change for hybrid SDKs or communicated to hybrid SDKs.
  • Public API changes reviewed by another Mobile SDK team member or implemented according to the develop docs spec.

🔮 Next steps

Issues

🤖 Generated with Claude Code

#skip-changelog

@github-actions

github-actions Bot commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

🚨 Detected changes in high risk code 🚨

High-risk code has higher potential to break the SDK and may be hard to test. To prevent severe bugs, apply the rollout process for releasing such changes and be extra careful when changing and reviewing these files:

  • sentry-android-core/src/main/java/io/sentry/android/core/InternalSentrySdk.java

@sentry

sentry Bot commented Nov 6, 2026 •

Copy link
Copy Markdown

📲 Install Builds

Android

🔗 App Name App ID Version Configuration
SDK Size io.sentry.tests.size 8.63.0 (1) release

⚙️ sentry-android Build Distribution Settings

@linear-code

linear-code Bot commented Nov 10, 2026

Copy link
Copy Markdown

JAVA-831

@runningcode
runningcode marked this pull request as ready for review November 10, 2026 08:13
@runningcode
runningcode requested review from a team and adinauer as code owners November 10, 2026 08:13
@runningcode
runningcode requested review from 0xadam-brown and markushi and removed request for a team November 10, 2026 08:13
@runningcode runningcode added the ship-it PR is ready to merge from a reviewer perspective label Nov 10, 2026
@runningcode
runningcode force-pushed the no/android-core-javadoc branch from b126005 to 7b17435 Compare November 10, 2026 08:24
@runningcode
runningcode changed the base branch from 9.x.x to main November 10, 2026 08:24
Error Prone never ran on sentry-android-core. Enabling it reports 34 Javadoc warnings, which
fail the build under -Werror:

- MissingSummary: turn the @return text into a "Returns ..." summary, and add summaries to
  Javadocs that only had block tags.
- InvalidBlockTag: replace the @noinspection unused Javadoc tags with @SuppressWarnings("unused"),
  which IntelliJ honors too.
- NotJavadoc: turn the Javadoc on methods of an anonymous class into regular comments.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@runningcode
runningcode force-pushed the no/android-core-javadoc branch from 7b17435 to 75e1184 Compare November 10, 2026 08:41
@runningcode
runningcode merged commit 76d7a36 into main Nov 10, 2026
34 checks passed
@runningcode
runningcode deleted the no/android-core-javadoc branch November 10, 2026 13:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ship-it PR is ready to merge from a reviewer perspective

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants