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

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>

Author: runningcode

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

@@ -51,7 +51,7 @@
 public final class InternalSentrySdk {
 
   /**
-   * @return a copy of the current scopes's topmost scope, or null in case the scopes is disabled
+   * Returns a copy of the current scopes's topmost scope, or null in case the scopes is disabled.
    */
   @Nullable
   public static IScope getCurrentScope() {

sentry-android-core/src/main/java/io/sentry/android/core/SentryAndroidOptions.java

@@ -851,8 +851,8 @@ public void setReportHistoricalMemoryLimiterExits(
   }
 
   /**
-   * @return true if performance-v2 is enabled. See {@link #setEnablePerformanceV2(boolean)} for
-   *     more details.
+   * Returns true if performance-v2 is enabled. See {@link #setEnablePerformanceV2(boolean)} for
+   * more details.
    */
   public boolean isEnablePerformanceV2() {
     return enablePerformanceV2;
@@ -871,8 +871,8 @@ public void setEnablePerformanceV2(final boolean enablePerformanceV2) {
   }
 
   /**
-   * @return true if standalone app start tracing is enabled. See {@link
-   *     #setEnableStandaloneAppStartTracing(boolean)} for more details.
+   * Returns true if standalone app start tracing is enabled. See {@link
+   * #setEnableStandaloneAppStartTracing(boolean)} for more details.
    */
   @ApiStatus.Experimental
   public boolean isEnableStandaloneAppStartTracing() {

sentry-android-core/src/main/java/io/sentry/android/core/SentryFrameMetrics.java

@@ -91,8 +91,9 @@ public SentryFrameMetrics duplicate() {
   }
 
   /**
+   * Returns the difference between two frame metrics (this minus other).
+   *
    * @param other the other frame metrics to compare to, usually the older one
-   * @return the difference between two frame metrics (this minus other)
    */
   @NotNull
   public SentryFrameMetrics diffTo(final @NotNull SentryFrameMetrics other) {
@@ -105,8 +106,8 @@ public SentryFrameMetrics diffTo(final @NotNull SentryFrameMetrics other) {
   }
 
   /**
-   * @return true if the frame metrics contain valid data, meaning all values are greater or equal
-   *     to 0
+   * Returns true if the frame metrics contain valid data, meaning all values are greater or equal
+   * to 0.
    */
   public boolean containsValidData() {
     return slowFrameCount >= 0

sentry-android-core/src/main/java/io/sentry/android/core/SentryFramesDelayResult.java

@@ -16,15 +16,13 @@ public SentryFramesDelayResult(
   }
 
   /**
-   * @return the total frame delay in seconds, or -1 if incalculable (e.g. no frame data available)
+   * Returns the total frame delay in seconds, or -1 if incalculable (e.g. no frame data available).
    */
   public double getDelaySeconds() {
     return delaySeconds;
   }
 
-  /**
-   * @return the number of frames that contributed to the delay (slow + frozen frames)
-   */
+  /** Returns the number of frames that contributed to the delay (slow + frozen frames). */
   public int getFramesContributingToDelayCount() {
     return framesContributingToDelayCount;
   }

sentry-android-core/src/main/java/io/sentry/android/core/anr/AnrCulpritIdentifier.java

@@ -89,8 +89,9 @@ public boolean equals(final Object obj) {
   }
 
   /**
+   * Returns the most common occurring stacktrace identified as the culprit.
+   *
    * @param stacks a list of stack traces to analyze
-   * @return the most common occurring stacktrace identified as the culprit
    */
   @Nullable
   public static AggregatedStackTrace identify(final @NotNull List<AnrStackTrace> stacks) {

sentry-android-core/src/main/java/io/sentry/android/core/internal/util/AndroidConnectionStatusProvider.java

@@ -304,7 +304,7 @@ private void updateCacheAndNotifyObservers(
               }
             }
 
-            /**
+            /*
              * Check if NetworkCapabilities change is significant for our observers. Only notify for
              * changes that affect connectivity status or connection type.
              */
@@ -334,7 +334,7 @@ private boolean isSignificantChange(@Nullable NetworkCapabilities newCapabilitie
               return false;
             }
 
-            /** Check if capabilities that affect connectivity status changed. */
+            /* Check if capabilities that affect connectivity status changed. */
             private boolean hasSignificantCapabilityChanges(
                 @NotNull NetworkCapabilities old, @NotNull NetworkCapabilities new_) {
               // Check capabilities we care about for connectivity determination
@@ -348,7 +348,7 @@ private boolean hasSignificantCapabilityChanges(
               return false;
             }
 
-            /** Check if transport types that affect connection type changed. */
+            /* Check if transport types that affect connection type changed. */
             private boolean hasSignificantTransportChanges(
                 @NotNull NetworkCapabilities old, @NotNull NetworkCapabilities new_) {
               // Check transports we care about for connection type determination

sentry-android-core/src/main/java/io/sentry/android/core/internal/util/Debouncer.java

@@ -27,8 +27,8 @@ public Debouncer(
   }
 
   /**
-   * @return true if the execution should be debounced due to maxExecutions executions being made
-   *     within waitTimeMs, otherwise false.
+   * Returns true if the execution should be debounced due to maxExecutions executions being made
+   * within waitTimeMs, otherwise false.
    */
   public boolean checkForDebounce() {
     final long now = timeProvider.getCurrentTimeMillis();

sentry-android-core/src/main/java/io/sentry/android/core/internal/util/ScreenshotUtils.java

@@ -29,9 +29,7 @@ public class ScreenshotUtils {
   private static final long CAPTURE_TIMEOUT_MS = 1000;
 
   // Used by Hybrid SDKs
-  /**
-   * @noinspection unused
-   */
+  @SuppressWarnings("unused")
   public static @Nullable byte[] takeScreenshot(
       final @NotNull Activity activity,
       final @NotNull ILogger logger,
@@ -58,8 +56,8 @@ public class ScreenshotUtils {
    * same way {@link io.sentry.android.core.ScreenshotEventProcessor} does for native errors.
    *
    * @see #captureMaskedScreenshot(Activity, SentryAndroidOptions, BuildInfoProvider, boolean)
-   * @noinspection unused
    */
+  @SuppressWarnings("unused")
   public static @Nullable byte[] takeMaskedScreenshot(
       final @NotNull Activity activity,
       final @NotNull SentryAndroidOptions options,

sentry-android-core/src/main/java/io/sentry/android/core/internal/util/SentryFrameMetricsCollector.java

@@ -413,9 +413,7 @@ private void trackCurrentWindow() {
     }
   }
 
-  /**
-   * @return the last known time a frame was started, according to the Choreographer
-   */
+  /** Returns the last known time a frame was started, according to the Choreographer. */
   public long getLastKnownFrameStartTimeNanos() {
     // Let's read the choreographer private field to get start timestamp of the frame, which
     // uses System.nanoTime() under the hood

sentry-android-core/src/main/java/io/sentry/android/core/performance/AppStartMetrics.java

@@ -121,16 +121,16 @@ public AppStartMetrics() {
   }
 
   /**
-   * @return the app start span Uses Process.getStartUptimeMillis() as start timestamp, which
-   *     requires API level 24+
+   * Returns the app start span. It uses Process.getStartUptimeMillis() as start timestamp, which
+   * requires API level 24+.
    */
   public @NotNull TimeSpan getAppStartTimeSpan() {
     return appStartSpan;
   }
 
   /**
-   * @return the app start span Uses Process.getStartUptimeMillis() as start timestamp, which
-   *     requires API level 24+
+   * Returns the app start span. It uses Process.getStartUptimeMillis() as start timestamp, which
+   * requires API level 24+.
    */
   public @NotNull TimeSpan createProcessInitSpan() {
     // AppStartSpan and CLASS_LOADED_UPTIME_MS can be modified at any time.
@@ -145,11 +145,12 @@ public AppStartMetrics() {
   }
 
   /**
-   * @return the SDK init time span, as measured pre-performance-v2 Uses ContentProvider/Sdk init
-   *     time as start timestamp
-   *     <p>Data is filled by either {@link io.sentry.android.core.SentryPerformanceProvider} with a
-   *     fallback to {@link io.sentry.android.core.SentryAndroid}. At least the start timestamp
-   *     should always be set.
+   * Returns the SDK init time span, as measured pre-performance-v2. Uses ContentProvider/Sdk init
+   * time as start timestamp.
+   *
+   * <p>Data is filled by either {@link io.sentry.android.core.SentryPerformanceProvider} with a
+   * fallback to {@link io.sentry.android.core.SentryAndroid}. At least the start timestamp should
+   * always be set.
    */
   public @NotNull TimeSpan getSdkInitTimeSpan() {
     return sdkInitTimeSpan;
@@ -339,8 +340,8 @@ public long getClassLoadedUptimeMs() {
   }
 
   /**
-   * @return the app start time span if it was started and perf-2 is enabled, falls back to the sdk
-   *     init time span otherwise
+   * Returns the app start time span if it was started and perf-2 is enabled, falls back to the sdk
+   * init time span otherwise.
    */
   public @NotNull TimeSpan getAppStartTimeSpanWithFallback(
       final @NotNull SentryAndroidOptions options) {
@@ -468,8 +469,8 @@ public void setCachedStartInfo(final @Nullable ApplicationStartInfo cachedStartI
    * Called by instrumentation
    *
    * @param application The application object where onCreate was called on
-   * @noinspection unused
    */
+  @SuppressWarnings("unused")
   public static void onApplicationCreate(final @NotNull Application application) {
     final long now = SystemClock.uptimeMillis();
 
@@ -484,8 +485,8 @@ public static void onApplicationCreate(final @NotNull Application application) {
    * Called by instrumentation
    *
    * @param application The application object where onCreate was called on
-   * @noinspection unused
    */
+  @SuppressWarnings("unused")
   public static void onApplicationPostCreate(final @NotNull Application application) {
     final long now = SystemClock.uptimeMillis();
 
@@ -755,8 +756,8 @@ public void onActivityDestroyed(@NonNull Activity activity) {
    * Called by instrumentation
    *
    * @param contentProvider The content provider where onCreate was called on
-   * @noinspection unused
    */
+  @SuppressWarnings("unused")
   public static void onContentProviderCreate(final @NotNull ContentProvider contentProvider) {
     final long now = SystemClock.uptimeMillis();
 
@@ -769,8 +770,8 @@ public static void onContentProviderCreate(final @NotNull ContentProvider conten
    * Called by instrumentation
    *
    * @param contentProvider The content provider where onCreate was called on
-   * @noinspection unused
    */
+  @SuppressWarnings("unused")
   public static void onContentProviderPostCreate(final @NotNull ContentProvider contentProvider) {
     final long now = SystemClock.uptimeMillis();