]> git.alsa-project.org Git - alsa-gobject.git/commitdiff
timer: optimize to gi-docgen 2024.1 or later, approximately
authorTakashi Sakamoto <o-takashi@sakamocchi.jp>
Sat, 12 Jul 2025 12:24:18 +0000 (21:24 +0900)
committer坂本 貴史 <o-takashi@sakamocchi.jp>
Sun, 13 Jul 2025 07:42:16 +0000 (16:42 +0900)
As long as building with gi-docgen 2025.3.1 in Ubuntu 25.04, some
annotations for SlaveClass become invalid and causes some warnings.

/usr/bin/gi-docgen generate --no-namespace-dir --config=doc/timer/alsatimer.toml --output-dir=doc/timer/alsatimer --content-dir=/home/mocchi/git/alsa-project.org/alsa-gobject/doc/timer src/timer/ALSATimer-0.0.gir
WARNING: Unknown namespace SlaveClass
slave_id. If the slave_class is [enum@SlaveClass.APPLICATION], the slave_id is for the PID of
                                ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~
WARNING: Unknown namespace SlaveClass
[enum@SlaveClass.SEQUENCER], the slave_id is the numeric ID of queue bound for timer device.
^~~~~~~~~~~~~~~~~~~~~~~~~~~
WARNING: Unknown namespace SlaveClass
slave_id. If the slave_class is [enum@SlaveClass.APPLICATION], the slave_id is for the PID of
                                ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~
WARNING: Unknown namespace SlaveClass
[enum@SlaveClass.SEQUENCER], the slave_id is the numeric ID of queue bound for timer device.
^~~~~~~~~~~~~~~~~~~~~~~~~~~
WARNING: Unknown namespace SlaveClass
slave_id. If the slave_class is [enum@SlaveClass.APPLICATION], the slave_id is for the PID of
                                ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~
WARNING: Unknown namespace SlaveClass
[enum@SlaveClass.SEQUENCER], the slave_id is the numeric ID of queue bound for timer device.
^~~~~~~~~~~~~~~~~~~~~~~~~~~

This commit suppresses the warnings by using the pattern of enum@class.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
src/timer/user-instance.c

index 6e2c737001a47c1d8fc7631132e817d57c590f17..35ad3e9277788941738a5f6da004916e52b717ad 100644 (file)
@@ -332,9 +332,9 @@ gboolean alsatimer_user_instance_attach(ALSATimerUserInstance *self, ALSATimerDe
  * @error: A [struct@GLib.Error]. Error is generated with domain of `ALSATimer.UserInstanceError`.
  *
  * Attach the instance as an slave to another instance indicated by a pair of slave_class and
- * slave_id. If the slave_class is [enum@SlaveClass:APPLICATION], the slave_id is for the PID of
+ * slave_id. If the slave_class is [enum@SlaveClass].APPLICATION, the slave_id is for the PID of
  * application process which owns the instance of timer. If the slave_class is
- * [enum@SlaveClass:SEQUENCER], the slave_id is the numeric ID of queue bound for timer device.
+ * [enum@SlaveClass].SEQUENCER, the slave_id is the numeric ID of queue bound for timer device.
  *
  * The call of function executes `ioctl(2)` system call with `SNDRV_TIMER_IOCTL_SELECT` command
  * for ALSA timer character device.