[go: nahoru, domu]

Address API council feedback no SnapPosition

Update kdocs to include information about return type of position method.

Test: N/A
Fixes: 323350731
Relnote: N/A
Change-Id: If234ef164ac0e037dccf51c7fcc798fdf7688c6a
diff --git a/compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/gestures/snapping/SnapPosition.kt b/compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/gestures/snapping/SnapPosition.kt
index 691bedf..b592443 100644
--- a/compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/gestures/snapping/SnapPosition.kt
+++ b/compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/gestures/snapping/SnapPosition.kt
@@ -46,6 +46,9 @@
      * content.
      * @param itemIndex The index of the item being positioned.
      * @param itemCount The total amount of items in the snapping container.
+     *
+     * @return The offset of the snap position where items will be aligned to in a snapping
+     * container.
      */
     fun position(
         layoutSize: Int,