Improve doc for {get,set}HintAvoidBackgroundClipping
Bug: 18414403
Change-Id: I4cc069ca8f13d7521aa94e3c18f776de69280e2f
diff --git a/core/java/android/app/Notification.java b/core/java/android/app/Notification.java
index dfe5cf5..07e8dc5 100644
--- a/core/java/android/app/Notification.java
+++ b/core/java/android/app/Notification.java
@@ -4986,7 +4986,9 @@
}
/**
- * Set a hint that this notification's background should not be clipped if possible.
+ * Set a hint that this notification's background should not be clipped if possible,
+ * and should instead be resized to fully display on the screen, retaining the aspect
+ * ratio of the image. This can be useful for images like barcodes or qr codes.
* @param hintAvoidBackgroundClipping {@code true} to avoid clipping if possible.
* @return this object for method chaining
*/
@@ -4997,7 +4999,9 @@
}
/**
- * Get a hint that this notification's background should not be clipped if possible.
+ * Get a hint that this notification's background should not be clipped if possible,
+ * and should instead be resized to fully display on the screen, retaining the aspect
+ * ratio of the image. This can be useful for images like barcodes or qr codes.
* @return {@code true} if it's ok if the background is clipped on the screen, false
* otherwise. The default value is {@code false} if this was never set.
*/