diff options
| author | Hunter Knepshield <hknepshield@google.com> | 2021-02-25 11:25:47 -0800 |
|---|---|---|
| committer | Hunter Knepshield <hknepshield@google.com> | 2021-02-25 23:16:20 +0000 |
| commit | 433d3576043396d1c06c8f552666a2759b7c5b1d (patch) | |
| tree | 3713219d29ebf40ea0a3958530acaa488e3785f6 /core/java | |
| parent | e0db8b998fcd70f5371b9a12695be32462506171 (diff) | |
[API review] Additional detail in BugreportCallback javadoc.
This covers edge cases left out of the previous generalization.
Bug: 180015324
Test: make
Change-Id: I309d17cd09434469b5d88275cd59e864f4830c3a
Diffstat (limited to 'core/java')
| -rw-r--r-- | core/java/android/os/BugreportManager.java | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/core/java/android/os/BugreportManager.java b/core/java/android/os/BugreportManager.java index a435ac12d33c..73bb8d566500 100644 --- a/core/java/android/os/BugreportManager.java +++ b/core/java/android/os/BugreportManager.java @@ -68,8 +68,11 @@ public final class BugreportManager { /** * An interface describing the callback for bugreport progress and status. * - * <p>In general, callers can expect to receive {@link #onProgress} calls as the bugreport - * progresses, followed by a terminal call to either {@link #onFinished} or {@link #onError}. + * <p>Callers will receive {@link #onProgress} calls as the bugreport progresses, followed by a + * terminal call to either {@link #onFinished} or {@link #onError}. + * + * <p>If an issue is encountered while starting the bugreport asynchronously, callers will + * receive an {@link #onError} call without any {@link #onProgress} callbacks. */ public abstract static class BugreportCallback { /** |