From 19d8c14c53b47cd00a4051aaa1c70852f1578848 Mon Sep 17 00:00:00 2001 From: Takashi Sakamoto Date: Tue, 19 Apr 2022 18:41:08 +0900 Subject: [PATCH] timer: device_params: link optimization to gi-docgen The gi-docgen supports enhancement of inter-document link. This commit is optimization to it. Signed-off-by: Takashi Sakamoto --- src/timer/device-params.c | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/src/timer/device-params.c b/src/timer/device-params.c index 4aaaf9f..c6480c1 100644 --- a/src/timer/device-params.c +++ b/src/timer/device-params.c @@ -2,16 +2,13 @@ #include "privates.h" /** - * SECTION: device-params - * @Title: ALSATimerDeviceParams - * @Short_description: A GObject-derived object to represent parameter of timer - * device. + * ALSATimerDeviceParams: + * A GObject-derived object to represent parameter of timer device. * - * A #ALSATimerDeviceParams is a GObject-derived object to represent parameter - * of timer device. The call of alsatimer_set_device_params() requires the - * instance of object. + * A [class@DeviceParams] is a GObject-derived object to represent parameter of timer device. The + * call of alsatimer_set_device_params() requires the instance of object. * - * The object wraps 'struct snd_timer_gparams' in UAPI of Linux sound subsystem. + * The object wraps `struct snd_timer_gparams` in UAPI of Linux sound subsystem. */ typedef struct { struct snd_timer_gparams params; @@ -98,9 +95,9 @@ static void alsatimer_device_params_init(ALSATimerDeviceParams *self) /** * alsatimer_device_params_new: * - * Instantiate #ALSATimerDeviceParams object and return the instance. + * Instantiate [class@DeviceParams] object and return the instance. * - * Returns: an instance of #ALSATimerDeviceParams. + * Returns: an instance of [class@DeviceParams]. */ ALSATimerDeviceParams *alsatimer_device_params_new() { -- 2.47.3