Skip to content

Commit

Permalink
Add minor KDoc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
mahozad committed Jan 21, 2024
1 parent 365e3b6 commit 92515b4
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ enum class WaveMovement {
*/
LTR,
/**
* Based on layout direction; on LTR move from right to left and on RTL move from left to right.
* Based on layout direction; on LTR move from right to left, on RTL move from left to right.
*/
AUTO
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ val SliderDefaults.ShouldFlatten: Boolean get() = defaultShouldFlatten
* The final rendered height of the wave will be [waveHeight] + [waveThickness].
* @param wavePeriod the duration it takes for the wave to move by [waveLength] horizontally.
* Setting to [Duration.ZERO] or outside `Int.MIN_VALUE..Int.MAX_VALUE` milliseconds stops the movement.
* @param waveMovement the horizontal movement of the whole wave. To stop the movement, see [wavePeriod].
* @param waveMovement the horizontal movement of the whole wave. To stop the movement, use [wavePeriod].
* @param waveThickness the thickness of the active line (whether animated or not).
* @param trackThickness the thickness of the inactive line.
* @param shouldFlatten whether to decrease the wave height the farther it is from the thumb.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ private val ThumbSize = DpSize(ThumbWidth, ThumbHeight)
* The final rendered height of the wave will be [waveHeight] + [waveThickness].
* @param wavePeriod the duration it takes for the wave to move by [waveLength] horizontally.
* Setting to [Duration.ZERO] or outside `Int.MIN_VALUE..Int.MAX_VALUE` milliseconds stops the movement.
* @param waveMovement the horizontal movement of the whole wave. To stop the movement, see [wavePeriod].
* @param waveMovement the horizontal movement of the whole wave. To stop the movement, use [wavePeriod].
* @param waveThickness the thickness of the active line (whether animated or not).
* @param trackThickness the thickness of the inactive line.
* @param shouldFlatten whether to decrease the wave height the farther it is from the thumb.
Expand Down Expand Up @@ -217,7 +217,7 @@ fun WavySlider(
* The final rendered height of the wave will be [waveHeight] + [waveThickness].
* @param wavePeriod the duration it takes for the wave to move by [waveLength] horizontally.
* Setting to [Duration.ZERO] or outside `Int.MIN_VALUE..Int.MAX_VALUE` milliseconds stops the movement.
* @param waveMovement the horizontal movement of the whole wave. To stop the movement, see [wavePeriod].
* @param waveMovement the horizontal movement of the whole wave. To stop the movement, use [wavePeriod].
* @param waveThickness the thickness of the active line (whether animated or not).
* @param trackThickness the thickness of the inactive line.
* @param shouldFlatten whether to decrease the wave height the farther it is from the thumb.
Expand Down

0 comments on commit 92515b4

Please sign in to comment.