summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author Chet Haase <chet@google.com> 2022-08-29 18:41:59 +0000
committer Chet Haase <chet@google.com> 2022-08-29 18:41:59 +0000
commit34cb4ed36b6b869221c4d0dd31ef640cee028efe (patch)
tree3b20b4b1e66e4d4f419c186fb7ad44f184005737
parent36a571bf15b5c151285429e5a74c29ff44106626 (diff)
Fix docs for FrameMetrics.TOTAL_DURATION
The existing docs are incorrect and misleading. This change fixes those docs to be more accurate. Bug: 244193434 Test: Doc-only fix, no testing needed Change-Id: I454786c2ef888417e96d7139efd1c922537188d6
-rw-r--r--core/java/android/view/FrameMetrics.java6
1 files changed, 4 insertions, 2 deletions
diff --git a/core/java/android/view/FrameMetrics.java b/core/java/android/view/FrameMetrics.java
index 380c1045aea8..9e25a3e18c0c 100644
--- a/core/java/android/view/FrameMetrics.java
+++ b/core/java/android/view/FrameMetrics.java
@@ -116,8 +116,10 @@ public final class FrameMetrics {
* and be issued to the display subsystem.
* </p>
* <p>
- * Equal to the sum of the values of all other time-valued metric
- * identifiers.
+ * The total duration is the difference in time between when the frame
+ * began and when it ended. This value may not be exactly equal to the
+ * sum of the values of all other time-valued metric identifiers because
+ * some stages may happen concurrently.
* </p>
*/
public static final int TOTAL_DURATION = 8;