]> git.alsa-project.org Git - alsa-gobject.git/commitdiff
timer: user_instance: fix function comment
authorTakashi Sakamoto <o-takashi@sakamocchi.jp>
Sat, 14 Nov 2020 08:28:09 +0000 (17:28 +0900)
committer坂本 貴史 <o-takashi@sakamocchi.jp>
Sun, 15 Nov 2020 00:19:56 +0000 (09:19 +0900)
The function comment for documentation includes wrong descriptions.

This commit corrects it.

Fixes: 3a6d788bf47d ("timer: user_instance: add an API to attach user instance to another instance as slave")
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
src/timer/user-instance.c

index b7e49dcf48e0211c2dc178afcd04af174a943663..f6b4cfb392a043f0c4d0198c8cf56a2718dd49f4 100644 (file)
@@ -254,16 +254,13 @@ void alsatimer_user_instance_attach(ALSATimerUserInstance *self,
  * @slave_id: The numerical identifier of master instance.
  * @error: A #GError.
  *
- * Attach the instance to timer device as an slave to another instance indicated
- * by a pair of slave_class and slave_id. If the slave_class is for application
+ * Attach the instance as an slave to another instance indicated by a pair of
+ * slave_class and slave_id. If the slave_class is for application
  * (=ALSATIMER_SLAVE_CLASS_APPLICATION), the slave_id is for the PID of
  * application process which owns the instance of timer. If the slave_class is
  * for ALSA sequencer (=ALSATIMER_SLAVE_CLASS_SEQUENCER), the slave_id is the
  * numerical ID of queue bound for timer device.
  *
- * Attach the instance to the timer device. If the given device_id is for
- * absent timer device, the instance can be detached with error.
- *
  * The call of function executes ioctl(2) system call with
  * SNDRV_TIMER_IOCTL_SELECT command for ALSA timer character device.
  */