Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 2e61e595 authored Sep 22, 2023 by Juan Sebastian Martinez

Fixed docstring on SliderTracker and SeekableSliderTracker

The docstring of the classes now correspond to the arguments in their
constructors.

Test: compiles
Bug: 295932558
Change-Id: Iab340e22dc2289e65d382c47d29b438cc8b05bba

parent 036c9104

packages/SystemUI/src/com/android/systemui/haptics/slider/SeekableSliderTracker.kt

+2 −2

Original line number	Diff line number	Diff line
		@@ -36,8 +36,8 @@ import kotlinx.coroutines.launch
		*
		* @param[sliderStateListener] Listener of the slider state.
		* @param[sliderEventProducer] Producer of slider events arising from the slider.
		* @property[scope] [CoroutineScope] where the collection of slider events and the launch of timer
		* jobs occur.
		* @param[mainDispatcher] [CoroutineDispatcher] used to launch coroutines for the collection of
		* slider events and the launch of timer jobs.
		* @property[config] Configuration parameters of the slider tracker.
		*/
		class SeekableSliderTracker(

packages/SystemUI/src/com/android/systemui/haptics/slider/SliderTracker.kt

+2 −1

Original line number	Diff line number	Diff line
		@@ -27,7 +27,8 @@ import kotlinx.coroutines.launch
		* The tracker maintains a state machine operated by slider events coming from a
		* [SliderEventProducer]. An action is executed in each state via a [SliderListener].
		*
		* @param[scope] [CoroutineScope] to launch the collection of [SliderEvent].
		* @property[scope] [CoroutineScope] to launch the collection of [SliderEvent] and state machine
		* logic.
		* @property[sliderListener] [SliderListener] to execute actions on a given [SliderState].
		* @property[eventProducer] Producer of [SliderEvent] to iterate over a state machine.
		*/