[libmanette] device: Document *_has_rumble() and *_rumble()



commit 4770fcf3530385579e489e81e5a0b7862b5460a9
Author: Adrien Plazas <kekun plazas laposte net>
Date:   Tue Nov 17 22:25:06 2020 +0100

    device: Document *_has_rumble() and *_rumble()
    
    This is particularly needed as they are public API and rumbling can be
    hard to understand if you didn't use rumbles before.

 src/manette-device.c | 18 ++++++++++--------
 1 file changed, 10 insertions(+), 8 deletions(-)
---
diff --git a/src/manette-device.c b/src/manette-device.c
index b539475..81fc043 100644
--- a/src/manette-device.c
+++ b/src/manette-device.c
@@ -822,9 +822,9 @@ manette_device_remove_user_mapping (ManetteDevice *self)
  * manette_device_has_rumble:
  * @self: a #ManetteDevice
  *
- * Checks whether device @self has a rumble motor.
+ * Gets whether @self supports rumble.
  *
- * Returns: whether device @self has a rumble motor.
+ * Returns: whether @self supports rumble
  */
 gboolean
 manette_device_has_rumble (ManetteDevice *self)
@@ -845,14 +845,16 @@ manette_device_has_rumble (ManetteDevice *self)
 /**
  * manette_device_rumble:
  * @self: a #ManetteDevice
- * @strong_magnitude: the magnitude for the heavy rumbling motor, when there's one
- * @weak_magnitude: the magnitude for the small rumbling motor
- * @duration: the rumble effect play time in milliseconds, with a maximum of 32767.
+ * @strong_magnitude: the magnitude for the heavy motor
+ * @weak_magnitude: the magnitude for the light motor
+ * @milliseconds: the rumble effect play time in milliseconds
  *
- * Make @self rumble during @duration milliseconds, with heavy motor rumbling at
- * magnitude @strong_magnitude and the small rumbling motor at magnitude @weak_magnitude.
+ * Make @self rumble during @milliseconds milliseconds, with the heavy and light
+ * motors rumbling at their respectively defined magnitudes.
  *
- * Returns: whether the rumble effect was played.
+ * The duration cannot exceed 32767 milliseconds.
+ *
+ * Returns: whether the rumble effect was played
  */
 gboolean
 manette_device_rumble (ManetteDevice *self,


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]