Updated KDocs for Percentage according to API Council comments.
Test: N/A
Bug: 237384580
Change-Id: Ic6d1fae3ebc85c17bccb4ceef7bfd9d74e822d71
diff --git a/health/health-connect-client/src/main/java/androidx/health/connect/client/units/Percentage.kt b/health/health-connect-client/src/main/java/androidx/health/connect/client/units/Percentage.kt
index a3a0aae..c7a13d1 100644
--- a/health/health-connect-client/src/main/java/androidx/health/connect/client/units/Percentage.kt
+++ b/health/health-connect-client/src/main/java/androidx/health/connect/client/units/Percentage.kt
@@ -16,7 +16,7 @@
package androidx.health.connect.client.units
-/** Represents a percentage value. */
+/** Represents a value as a percentage, not a fraction - for example 100%, 89.62%, etc. */
class Percentage(val value: Double) : Comparable<Percentage> {
override fun compareTo(other: Percentage): Int = value.compareTo(other.value)
@@ -43,22 +43,22 @@
override fun toString(): String = "$value%"
}
-/** Creates [Percentage] with the specified value. */
+/** Creates [Percentage] with the specified percentage value, not a fraction. */
@get:JvmSynthetic
val Double.percent: Percentage
get() = Percentage(value = this)
-/** Creates [Percentage] with the specified value. */
+/** Creates [Percentage] with the specified percentage value, not a fraction. */
@get:JvmSynthetic
val Long.percent: Percentage
get() = toDouble().percent
-/** Creates [Percentage] with the specified value. */
+/** Creates [Percentage] with the specified percentage value, not a fraction. */
@get:JvmSynthetic
val Float.percent: Percentage
get() = toDouble().percent
-/** Creates [Percentage] with the specified value. */
+/** Creates [Percentage] with the specified percentage value, not a fraction. */
@get:JvmSynthetic
val Int.percent: Percentage
get() = toDouble().percent