doc(JavaDoc): fixed the code snippets and formatting of the JavaDoc for Configuration & Bugsnag

Author: lemnik

bugsnag-android-core/src/main/java/com/bugsnag/android/Bugsnag.java

@@ -14,8 +14,10 @@
  * Static access to a Bugsnag Client, the easiest way to use Bugsnag in your Android app.
  * For example:
  * <p>
+ * <pre>{@code
  * Bugsnag.start(this, "your-api-key");
  * Bugsnag.notify(new RuntimeException("something broke!"));
+ * }</pre>
  *
  * @see Client
  */
@@ -72,7 +74,7 @@ public static Client start(@NonNull Context androidContext, @NonNull Configurati
     /**
      * Returns true if one of the <code>start</code> methods have been has been called and
      * so Bugsnag is initialized; false if <code>start</code> has not been called and the
-     * other methods will throw IllegalStateException.
+     * other methods will throw {@code IllegalStateException}.
      */
     public static boolean isStarted() {
         return client != null;
@@ -149,12 +151,12 @@ public static User getUser() {
      * <p>
      * For example:
      * <p>
-     * Bugsnag.addOnError(new OnErrorCallback() {
-     * public boolean run(Event event) {
-     * event.setSeverity(Severity.INFO);
-     * return true;
-     * }
-     * })
+     * <pre>{@code
+     * Bugsnag.addOnError((Event event) -> {
+     *     event.setSeverity(Severity.INFO);
+     *     return true;
+     * });
+     * }</pre>
      *
      * @param onError a callback to run before sending errors to Bugsnag
      * @see OnErrorCallback
@@ -181,11 +183,11 @@ public static void removeOnError(@NonNull OnErrorCallback onError) {
      * <p>
      * For example:
      * <p>
-     * Bugsnag.onBreadcrumb(new OnBreadcrumbCallback() {
-     * public boolean run(Breadcrumb breadcrumb) {
-     * return false; // ignore the breadcrumb
-     * }
-     * })
+     * <pre>{@code
+     * Bugsnag.onBreadcrumb((Breadcrumb breadcrumb) -> {
+     *     return false; // ignore the breadcrumb
+     * });
+     * }</pre>
      *
      * @param onBreadcrumb a callback to run before a breadcrumb is captured
      * @see OnBreadcrumbCallback
@@ -212,11 +214,11 @@ public static void removeOnBreadcrumb(@NonNull OnBreadcrumbCallback onBreadcrumb
      * <p>
      * For example:
      * <p>
-     * Bugsnag.onSession(new OnSessionCallback() {
-     * public boolean run(Session session) {
-     * return false; // ignore the session
-     * }
-     * })
+     * <pre>{@code
+     * Bugsnag.onSession((Session session) -> {
+     *     return false; // ignore the session
+     * });
+     * }</pre>
      *
      * @param onSession a callback to run before a session is captured
      * @see OnSessionCallback

bugsnag-android-core/src/main/java/com/bugsnag/android/Configuration.java

@@ -102,7 +102,7 @@ public void setVersionCode(@Nullable Integer versionCode) {
 
     /**
      * If you would like to distinguish between errors that happen in different stages of the
-     * application release process (development, production, etc) you can set the releaseStage
+     * application release process (development, production, etc.) you can set the releaseStage
      * that is reported to Bugsnag.
      * <p>
      * If you are running a debug build, we'll automatically set this to "development",
@@ -116,7 +116,7 @@ public String getReleaseStage() {
 
     /**
      * If you would like to distinguish between errors that happen in different stages of the
-     * application release process (development, production, etc) you can set the releaseStage
+     * application release process (development, production, etc.) you can set the releaseStage
      * that is reported to Bugsnag.
      * <p>
      * If you are running a debug build, we'll automatically set this to "development",
@@ -168,7 +168,7 @@ public boolean getPersistUser() {
     }
 
     /**
-     * Set whether or not Bugsnag should persist user information between application sessions.
+     * Set whether Bugsnag should persist user information between application sessions.
      * <p>
      * If enabled then any user information set will be re-used until the user information is
      * removed manually by calling {@link Bugsnag#setUser(String, String, String)}
@@ -179,7 +179,7 @@ public void setPersistUser(boolean persistUser) {
     }
 
     /**
-     * Set whether or not Bugsnag should generate an anonymous ID and persist it in local storage
+     * Set whether Bugsnag should generate an anonymous ID and persist it in local storage
      * <p>
      * If disabled, any device ID that has been persisted will not be retrieved, and no new
      * device ID will be generated or stored
@@ -189,7 +189,7 @@ public boolean getGenerateAnonymousId() {
     }
 
     /**
-     * Set whether or not Bugsnag should generate an anonymous ID and persist it in local storage
+     * Set whether Bugsnag should generate an anonymous ID and persist it in local storage
      * <p>
      * If disabled, any device ID that has been persisted will not be retrieved, and no new
      * device ID will be generated or stored
@@ -226,7 +226,7 @@ public File getPersistenceDirectory() {
      * The persistenceDirectory also stores user information if {@link #getPersistUser()} has been
      * set to true.
      * <p/>
-     * By default, bugsnag sets the persistenceDirectory to {@link Context#getCacheDir()}.
+     * By default, Bugsnag sets the persistenceDirectory to {@link Context#getCacheDir()}.
      * <p/>
      * If the persistenceDirectory is changed between application launches, no attempt will be made
      * to deliver events or sessions cached in the previous location.
@@ -236,7 +236,7 @@ public void setPersistenceDirectory(@Nullable File directory) {
     }
 
     /**
-     * Sets whether or not Bugsnag should send crashes synchronously that occurred during
+     * Sets whether Bugsnag should send crashes synchronously that occurred during
      * the application's launch period. By default this behavior is enabled.
      * <p>
      * See {@link #setLaunchDurationMillis(long)}
@@ -246,10 +246,10 @@ public boolean getSendLaunchCrashesSynchronously() {
     }
 
     /**
-     * Sets whether or not Bugsnag should send crashes synchronously that occurred during
+     * Sets whether Bugsnag should send crashes synchronously that occurred during
      * the application's launch period. By default this behavior is enabled.
      * <p>
-     * See {@link #setLaunchDurationMillis(long)}
+     * @see #setLaunchDurationMillis(long)
      */
     public void setSendLaunchCrashesSynchronously(boolean sendLaunchCrashesSynchronously) {
         impl.setSendLaunchCrashesSynchronously(sendLaunchCrashesSynchronously);
@@ -261,7 +261,7 @@ public void setSendLaunchCrashesSynchronously(boolean sendLaunchCrashesSynchrono
      * event synchronously.
      * <p>
      * By default, this value is set at 5,000ms. Setting the value to 0 will count all crashes
-     * as launch crashes until markLaunchCompleted() is called.
+     * as launch crashes until {@link Bugsnag#markLaunchCompleted()} is called.
      */
     public long getLaunchDurationMillis() {
         return impl.getLaunchDurationMillis();
@@ -286,7 +286,7 @@ public void setLaunchDurationMillis(@IntRange(from = 0) long launchDurationMilli
     }
 
     /**
-     * Sets whether or not Bugsnag should automatically capture and report User sessions whenever
+     * Sets whether Bugsnag should automatically capture and report User sessions whenever
      * the app enters the foreground.
      * <p>
      * By default this behavior is enabled.
@@ -296,7 +296,7 @@ public boolean getAutoTrackSessions() {
     }
 
     /**
-     * Sets whether or not Bugsnag should automatically capture and report User sessions whenever
+     * Sets whether Bugsnag should automatically capture and report User sessions whenever
      * the app enters the foreground.
      * <p>
      * By default this behavior is enabled.
@@ -416,10 +416,10 @@ public void setLogger(@Nullable Logger logger) {
      * You can use the return type from the deliver functions to control the strategy for
      * retrying the transmission at a later date.
      * <p>
-     * If DeliveryStatus.UNDELIVERED is returned, the notifier will automatically cache
-     * the payload and trigger delivery later on. Otherwise, if either DeliveryStatus.DELIVERED
-     * or DeliveryStatus.FAILURE is returned the notifier will removed any cached payload
-     * and no further delivery will be attempted.
+     * If {@link DeliveryStatus#UNDELIVERED} is returned, the notifier will automatically cache
+     * the payload and trigger delivery later on. Otherwise, if either
+     * {@link DeliveryStatus#DELIVERED} or {@link DeliveryStatus#FAILURE} is returned the notifier
+     * will remove any cached payload and no further delivery will be attempted.
      */
     @NonNull
     public Delivery getDelivery() {
@@ -734,14 +734,15 @@ public void setEnabledReleaseStages(@Nullable Set<String> enabledReleaseStages)
      * empty set.
      * <p>
      * The following breadcrumb types can be enabled:
-     * <p>
-     * - Captured errors: left when an error event is sent to the Bugsnag API.
-     * - Manual breadcrumbs: left via the Bugsnag.leaveBreadcrumb function.
-     * - Navigation changes: left for Activity Lifecycle events to track the user's journey in
-     * the app.
-     * - State changes: state breadcrumbs are left for system broadcast events. For example:
-     * battery warnings, airplane mode, etc.
-     * - User interaction: left when the user performs certain system operations.
+     * <ul>
+     * <li>Captured errors: left when an error event is sent to the Bugsnag API.</li>
+     * <li>Manual breadcrumbs: left via the Bugsnag.leaveBreadcrumb function.</li>
+     * <li>Navigation changes: left for Activity Lifecycle events to track the user's journey in
+     * the app.</li>
+     * <li>State changes: state breadcrumbs are left for system broadcast events. For example:
+     * battery warnings, airplane mode, etc.</li>
+     * <li>User interaction: left when the user performs certain system operations.</li>
+     * </ul>
      */
     @Nullable
     public Set<BreadcrumbType> getEnabledBreadcrumbTypes() {
@@ -755,14 +756,15 @@ public Set<BreadcrumbType> getEnabledBreadcrumbTypes() {
      * empty set.
      * <p>
      * The following breadcrumb types can be enabled:
-     * <p>
-     * - Captured errors: left when an error event is sent to the Bugsnag API.
-     * - Manual breadcrumbs: left via the Bugsnag.leaveBreadcrumb function.
-     * - Navigation changes: left for Activity Lifecycle events to track the user's journey in
-     * the app.
-     * - State changes: state breadcrumbs are left for system broadcast events. For example:
-     * battery warnings, airplane mode, etc.
-     * - User interaction: left when the user performs certain system operations.
+     * <ul>
+     * <li>Captured errors: left when an error event is sent to the Bugsnag API.</li>
+     * <li>Manual breadcrumbs: left via the Bugsnag.leaveBreadcrumb function.</li>
+     * <li>Navigation changes: left for Activity Lifecycle events to track the user's journey in
+     * the app.</li>
+     * <li>State changes: state breadcrumbs are left for system broadcast events. For example:
+     * battery warnings, airplane mode, etc.</li>
+     * <li>User interaction: left when the user performs certain system operations.</li>
+     * </ul>
      */
     public void setEnabledBreadcrumbTypes(@Nullable Set<BreadcrumbType> enabledBreadcrumbTypes) {
         impl.setEnabledBreadcrumbTypes(enabledBreadcrumbTypes);
@@ -778,7 +780,10 @@ public Set<Telemetry> getTelemetry() {
      * <p>
      * The following telemetry can be enabled:
      * <p>
-     * - internal errors: Errors in the Bugsnag SDK itself.
+     * <ul>
+     * <li>internal errors: Errors in the Bugsnag SDK itself</li>
+     * <li>usage: Differences from the default configuration</li>
+     * </ul>
      */
     public void setTelemetry(@NonNull Set<Telemetry> telemetry) {
         if (telemetry != null) {
@@ -794,7 +799,7 @@ public void setTelemetry(@NonNull Set<Telemetry> telemetry) {
      * originate from any of these packages and this allows us to improve
      * the visual display of the stacktrace on the dashboard.
      * <p>
-     * By default, projectPackages is set to be the package you called Bugsnag.start from.
+     * By default, projectPackages is set to be the package you called {@link Bugsnag#start} from.
      */
     @NonNull
     public Set<String> getProjectPackages() {
@@ -807,7 +812,7 @@ public Set<String> getProjectPackages() {
      * originate from any of these packages and this allows us to improve
      * the visual display of the stacktrace on the dashboard.
      * <p>
-     * By default, projectPackages is set to be the package you called Bugsnag.start from.
+     * By default, projectPackages is set to be the package you called {@link Bugsnag#start} from.
      */
     public void setProjectPackages(@NonNull Set<String> projectPackages) {
         if (CollectionUtils.containsNullElements(projectPackages)) {
@@ -818,7 +823,7 @@ public void setProjectPackages(@NonNull Set<String> projectPackages) {
     }
 
     /**
-     * Add a "on error" callback, to execute code at the point where an error report is
+     * Add an "on error" callback, to execute code at the point where an error report is
      * captured in Bugsnag.
      * <p>
      * You can use this to add or modify information attached to an Event
@@ -829,11 +834,9 @@ public void setProjectPackages(@NonNull Set<String> projectPackages) {
      * <p>
      * For example:
      * <pre>{@code
-     * Bugsnag.addOnError(new OnErrorCallback() {
-     *     public boolean onError(Event event) {
-     *         event.setSeverity(Severity.INFO);
-     *         return true;
-     *     }
+     * Bugsnag.addOnError((event) -> {
+     *     event.setSeverity(Severity.INFO);
+     *     return true;
      * });
      * }</pre>
      *
@@ -872,10 +875,8 @@ public void removeOnError(@NonNull OnErrorCallback onError) {
      * <p>
      * For example:
      * <pre>{@code
-     * Bugsnag.onBreadcrumb(new OnBreadcrumbCallback() {
-     *     public boolean run(Breadcrumb breadcrumb) {
-     *         return false; // ignore the breadcrumb
-     *     }
+     * Bugsnag.addOnBreadcrumb((breadcrumb) -> {
+     *     return false; // ignore the breadcrumb
      * });
      * }</pre>
      *