From 861f0c7a65f30f05893f5299f69e75bfdb17ab48 Mon Sep 17 00:00:00 2001 From: Shubham Singh Date: Mon, 18 Nov 2024 14:26:57 +0530 Subject: [PATCH] Add missing documentation for MenstruationFlow KHRecord --- khealth/src/commonMain/kotlin/com/khealth/KHRecord.kt | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/khealth/src/commonMain/kotlin/com/khealth/KHRecord.kt b/khealth/src/commonMain/kotlin/com/khealth/KHRecord.kt index b9b99db..8d6b509 100644 --- a/khealth/src/commonMain/kotlin/com/khealth/KHRecord.kt +++ b/khealth/src/commonMain/kotlin/com/khealth/KHRecord.kt @@ -322,7 +322,11 @@ sealed class KHRecord(internal val dataType: KHDataType) { * Captures a description of how heavy a user's menstrual flow was (light, medium, or heavy). * Each record represents a description of how heavy the user's menstrual bleeding was. * + * @param type The pattern or characteristics of menstrual bleeding, such as light, moderate, + * or heavy flow * @param time Time instant of the interval over which the value this record was captured + * @param isStartOfCycle Metadata that describes whether this event is the start of the + * menstruation cycle (applied on `Apple` platforms only) */ data class MenstruationFlow( val type: KHMenstruationFlowType,