]> git.alsa-project.org Git - alsa-gobject.git/commitdiff
seq: queue_info: link optimization to gi-docgen
authorTakashi Sakamoto <o-takashi@sakamocchi.jp>
Tue, 19 Apr 2022 09:41:08 +0000 (18:41 +0900)
committerTakashi Sakamoto <o-takashi@sakamocchi.jp>
Tue, 19 Apr 2022 09:41:08 +0000 (18:41 +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/seq/queue-info.c

index 8f3648e8cf9afdcbd7a70c66bc36f4eb61466808..f73fc2caad60be80482197ebb1cb18827ba27649 100644 (file)
@@ -2,18 +2,15 @@
 #include "privates.h"
 
 /**
- * SECTION: queue-info
- * @Title: ALSASeqQueueInfo
- * @Short_description: A GObject-derived object to represent information of
- *                     queue
+ * ALSASeqQueueInfo:
+ * A GObject-derived object to represent information of queue.
  *
- * A #ALSASeqQueueInfo is a GObject-derived object to represent information of
- * queue. The call of alsaseq_get_queue_info_by_id() and
- * alsaseq_get_queue_info_by_name() returns the instance of object. The call of
- * alsaseq_user_client_create_queue() and alsaseq_user_client_update_queue()
- * requires the instance of object.
+ * A [class@QueueInfo] is a GObject-derived object to represent information of queue. The call of
+ * [func@get_queue_info_by_id] and [func@get_queue_info_by_name] returns the instance of object.
+ * The call of [method@UserClient.create_queue] and [method@UserClient.update_queue] requires the
+ * instance of object.
  *
- * The object wraps 'struct snd_seq_queue_info' in UAPI of Linux sound subsystem.
+ * The object wraps `struct snd_seq_queue_info` in UAPI of Linux sound subsystem.
  */
 typedef struct {
     struct snd_seq_queue_info info;
@@ -129,9 +126,9 @@ static void alsaseq_queue_info_init(ALSASeqQueueInfo *self)
 /**
  * alsaseq_queue_info_new:
  *
- * Allocate and return an instance of ALSASeqQueueInfo.
+ * Allocate and return an instance of [class@QueueInfo].
  *
- * Returns: A #ALSASeqQueueInfo.
+ * Returns: An instance of [class@QueueInfo].
  */
 ALSASeqQueueInfo *alsaseq_queue_info_new()
 {