]> git.alsa-project.org Git - alsa-gobject.git/commitdiff
timer: device_params: link optimization to gi-docgen
authorTakashi Sakamoto <o-takashi@sakamocchi.jp>
Tue, 19 Apr 2022 09:41:08 +0000 (18:41 +0900)
committer坂本 貴史 <o-takashi@sakamocchi.jp>
Wed, 20 Apr 2022 00:51:44 +0000 (09:51 +0900)
The gi-docgen supports enhancement of inter-document link. This commit is
optimization to it.

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

index 4aaaf9faecac7f0841bae9c51785e21176195284..c6480c173b91fc07fd40983f9a568e82d09db065 100644 (file)
@@ -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()
 {