]> git.alsa-project.org Git - alsa-gobject.git/commitdiff
seq: event_data_connect: 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/event-data-connect.c

index 1e095b5f8fe8118ef597a704dea5bf88b7008b17..020339c1af65aafb479f554e2e12ef99ca8d57b9 100644 (file)
@@ -2,14 +2,13 @@
 #include "privates.h"
 
 /**
- * SECTION: event-data-connect
- * @Title: ALSASeqEventDataConnect
- * @Short_description: A boxed object to represent data of connect event
+ * ALSASeqEventDataConnect:
+ * A boxed object to represent data of connect event.
  *
- * A #ALSASeqEventDataConnect is a boxed object to represent data of connect
- * event. The instance of object is one of data properties in event.
+ * A [struct@EventDataConnect] is a boxed object to represent data of connect event. The instance
+ * of object is one of data properties in event.
  *
- * The object wraps 'struct snd_seq_connect' in UAPI of Linux sound subsystem.
+ * The object wraps `struct snd_seq_connect` in UAPI of Linux sound subsystem.
  */
 ALSASeqEventDataConnect *seq_event_data_connect_copy(const ALSASeqEventDataConnect *self)
 {
@@ -28,7 +27,7 @@ G_DEFINE_BOXED_TYPE(ALSASeqEventDataConnect, alsaseq_event_data_connect, seq_eve
 
 /**
  * alsaseq_event_data_connect_get_src:
- * @self: A #ALSASeqEventDataConnect.
+ * @self: A [struct@EventDataConnect].
  * @src: (out)(transfer none): The source of connection event.
  *
  * Get the source of connection event.
@@ -41,8 +40,8 @@ void alsaseq_event_data_connect_get_src(const ALSASeqEventDataConnect *self,
 
 /**
  * alsaseq_event_data_connect_set_src:
- * @self: A #ALSASeqEventDataConnect.
- * @src: A #ALSASeqAddr.
+ * @self: A [struct@EventDataConnect].
+ * @src: A [struct@Addr].
  *
  * Set the source to the connection event.
  */
@@ -54,7 +53,7 @@ void alsaseq_event_data_connect_set_src(ALSASeqEventDataConnect *self,
 
 /**
  * alsaseq_event_data_connect_get_dst:
- * @self: A #ALSASeqEventDataConnect.
+ * @self: A [struct@EventDataConnect].
  * @dst: (out)(transfer none): The destination of connection event.
  *
  * Get the destination of connection event.
@@ -67,8 +66,8 @@ void alsaseq_event_data_connect_get_dst(const ALSASeqEventDataConnect *self,
 
 /**
  * alsaseq_event_data_connect_set_dst:
- * @self: A #ALSASeqEventDataConnect.
- * @dst: A #ALSASeqAddr.
+ * @self: A [struct@EventDataConnect].
+ * @dst: A [struct@Addr].
  *
  * Set the source to the connection event.
  */