add doc for modifier

PostHog · Oct 16, 2024 · 72d5908 · 72d5908
1 parent 5a400b5
commit 72d5908
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/posthog-android/src/main/java/com/posthog/android/replay/PostHogMaskModifier.kt b/posthog-android/src/main/java/com/posthog/android/replay/PostHogMaskModifier.kt
@@ -7,6 +7,9 @@ import androidx.compose.ui.semantics.semantics
 public object PostHogMaskModifier {
     internal val PostHogReplayMask = SemanticsPropertyKey<Boolean>("ph-no-capture")
 
+    /**
+     * Marks the element as not to be captured by PostHog Session Replay.
+     */
     public fun Modifier.postHogMaskReplay(): Modifier {
         return semantics(
             properties = {