Skip to content

Commit fd20cd1

Browse files
committed
timer: optimize to gi-docgen 2024.1 or later, approximately
As long as building with gi-docgen 2025.3.1 in Ubuntu 25.10, 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>
1 parent 3b1d8a5 commit fd20cd1

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

src/timer/user-instance.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -332,9 +332,9 @@ gboolean alsatimer_user_instance_attach(ALSATimerUserInstance *self, ALSATimerDe
332332
* @error: A [struct@GLib.Error]. Error is generated with domain of `ALSATimer.UserInstanceError`.
333333
*
334334
* Attach the instance as an slave to another instance indicated by a pair of slave_class and
335-
* slave_id. If the slave_class is [enum@SlaveClass:APPLICATION], the slave_id is for the PID of
335+
* slave_id. If the slave_class is [enum@SlaveClass].APPLICATION, the slave_id is for the PID of
336336
* application process which owns the instance of timer. If the slave_class is
337-
* [enum@SlaveClass:SEQUENCER], the slave_id is the numeric ID of queue bound for timer device.
337+
* [enum@SlaveClass].SEQUENCER, the slave_id is the numeric ID of queue bound for timer device.
338338
*
339339
* The call of function executes `ioctl(2)` system call with `SNDRV_TIMER_IOCTL_SELECT` command
340340
* for ALSA timer character device.

0 commit comments

Comments
 (0)