]> git.alsa-project.org Git - alsa-gobject.git/commitdiff
hwdep: device_info: 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/hwdep/device-info.c

index 3bc163f28d94a9fc260947e4b46fc566a5ea0e45..30287a72d88c1e2833defb6cc1d96d6bb9d6d358 100644 (file)
@@ -2,16 +2,13 @@
 #include "privates.h"
 
 /**
- * SECTION: device-info
- * @Title: ALSAHwdepDeviceInfo
- * @Short_description: A GObject-derived object to represent information of
- *                     ALSA hwdep device.
+ * ALSAHwdepDeviceInfo:
+ * A GObject-derived object to represent information of ALSA hwdep device.
  *
- * A #ALSAHwdepDeviceInfo is a GObject-derived object to represent information
- * of ALSA hwdep device. The call of alsahwdep_get_device_info() returns an
- * instance of the object.
+ * A [class@DeviceInfo] is a GObject-derived object to represent information of ALSA hwdep device.
+ * The call of [func@get_device_info] returns an instance of the object.
  *
- * The object wraps 'struct snd_hwdep_info' in UAPI of Linux sound subsystem.
+ * The object wraps `struct snd_hwdep_info` in UAPI of Linux sound subsystem.
  */
 typedef struct {
     struct snd_hwdep_info info;