]> git.alsa-project.org Git - alsa-gobject.git/commitdiff
seq: event_data_result: link optimization to gi-docgen topic/doc-optimization
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-result.c

index c0741cfc3417c8b4d667974e103cba75b0575ffc..0b56b20d8526603e0f446aad9b31e7261025ba6a 100644 (file)
@@ -2,14 +2,13 @@
 #include "privates.h"
 
 /**
- * SECTION: event-data-result
- * @Title: ALSASeqEventDataResult
- * @Short_description: A boxed object to represent data of result event
+ * ALSASeqEventDataResult:
+ * A boxed object to represent data of result event.
  *
- * A #ALSASeqEventDataResult is a boxed object to represent data of result
- * event. The instance of object is one of data properties in event.
+ * A [struct@EventDataResult] is a boxed object to represent data of result event. The instance of
+ * object is one of data properties in event.
  *
- * The object wraps 'struct snd_seq_result' in UAPI of Linux sound subsystem.
+ * The object wraps `struct snd_seq_result` in UAPI of Linux sound subsystem.
  */
 ALSASeqEventDataResult *seq_event_data_result_copy(const ALSASeqEventDataResult *self)
 {
@@ -28,7 +27,7 @@ G_DEFINE_BOXED_TYPE(ALSASeqEventDataResult, alsaseq_event_data_result, seq_event
 
 /**
  * alsaseq_event_data_result_get_event:
- * @self: A #ALSASeqEventDataResult.
+ * @self: A [struct@EventDataResult].
  * @event_type: (out): The type of event in which the data results.
  *
  * Get the type of event in which the data results.
@@ -41,7 +40,7 @@ void alsaseq_event_data_result_get_event(const ALSASeqEventDataResult *self,
 
 /**
  * alsaseq_event_data_result_set_event:
- * @self: A #ALSASeqEventDataResult.
+ * @self: A [struct@EventDataResult].
  * @event_type: A #ALSASeqEventType.
  *
  * Set the type of event in which the data results.
@@ -54,7 +53,7 @@ void alsaseq_event_data_result_set_event(ALSASeqEventDataResult *self,
 
 /**
  * alsaseq_event_data_result_get_result:
- * @self: A #ALSASeqEventDataResult.
+ * @self: A [struct@EventDataResult].
  * @result: (out): the status of the event.
  *
  * Get the status of event.
@@ -67,7 +66,7 @@ void alsaseq_event_data_result_get_result(const ALSASeqEventDataResult *self,
 
 /**
  * alsaseq_event_data_result_set_result:
- * @self: A #ALSASeqEventDataResult.
+ * @self: A [struct@EventDataResult].
  * @result: The status of event.
  *
  * Set the status of event.