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

index cd5b46b819c1bbb95f8237f88c5dfa477ff84e05..486532415d3f3adc66de117e27583faa896b2eae 100644 (file)
@@ -2,14 +2,13 @@
 #include "privates.h"
 
 /**
- * SECTION: event-data-note
- * @Title: ALSASeqEventDataNote
- * @Short_description: A boxed object to represent data of note event
+ * ALSASeqEventDataNote:
+ * A boxed object to represent data of note event.
  *
- * A #ALSASeqEventDataNote is a boxed object to represent data of note event.
- * The instance of object is one of data properties in event.
+ * A [struct@EventDataNote] is a boxed object to represent data of note event. The instance of
+ * object is one of data properties in event.
  *
- * The object wraps 'struct snd_seq_ev_note' in UAPI of Linux sound subsystem.
+ * The object wraps `struct snd_seq_ev_note` in UAPI of Linux sound subsystem.
  */
 ALSASeqEventDataNote *seq_event_data_note_copy(const ALSASeqEventDataNote *self)
 {
@@ -28,7 +27,7 @@ G_DEFINE_BOXED_TYPE(ALSASeqEventDataNote, alsaseq_event_data_note, seq_event_dat
 
 /**
  * alsaseq_event_data_note_get_channel:
- * @self: A #ALSASeqEventDataNote.
+ * @self: A [struct@EventDataNote].
  * @channel: (out): The value of channel in the note event.
  *
  * Get the value of channel in the note event.
@@ -41,7 +40,7 @@ void alsaseq_event_data_note_get_channel(const ALSASeqEventDataNote *self,
 
 /**
  * alsaseq_event_data_note_set_channel:
- * @self: A #ALSASeqEventDataNote.
+ * @self: A [struct@EventDataNote].
  * @channel: The value of channel for the note event.
  *
  * Set the value of channel for the note event.
@@ -54,7 +53,7 @@ void alsaseq_event_data_note_set_channel(ALSASeqEventDataNote *self,
 
 /**
  * alsaseq_event_data_note_get_note:
- * @self: A #ALSASeqEventDataNote.
+ * @self: A [struct@EventDataNote].
  * @note: (out): The value of note in the note event.
  *
  * Get the value of note in the note event.
@@ -67,7 +66,7 @@ void alsaseq_event_data_note_get_note(const ALSASeqEventDataNote *self,
 
 /**
  * alsaseq_event_data_note_set_note:
- * @self: A #ALSASeqEventDataNote.
+ * @self: A [struct@EventDataNote].
  * @note: The value of note for the note event.
  *
  * Set the value of note for the note event.
@@ -79,7 +78,7 @@ void alsaseq_event_data_note_set_note(ALSASeqEventDataNote *self, guint8 note)
 
 /**
  * alsaseq_event_data_note_get_velocity:
- * @self: A #ALSASeqEventDataNote.
+ * @self: A [struct@EventDataNote].
  * @velocity: (out): The value of velocity in the note event.
  *
  * Get the value of velocity in the note event.
@@ -92,7 +91,7 @@ void alsaseq_event_data_note_get_velocity(const ALSASeqEventDataNote *self,
 
 /**
  * alsaseq_event_data_note_set_velocity:
- * @self: A #ALSASeqEventDataNote.
+ * @self: A [struct@EventDataNote].
  * @velocity: The value of note for the velocity event.
  *
  * Set the value of note for the velocity event.
@@ -105,7 +104,7 @@ void alsaseq_event_data_note_set_velocity(ALSASeqEventDataNote *self,
 
 /**
  * alsaseq_event_data_note_get_off_velocity:
- * @self: A #ALSASeqEventDataNote.
+ * @self: A [struct@EventDataNote].
  * @off_velocity: (out): The value of off-velocity in the note event.
  *
  * Get the value of off-velocity in the note event.
@@ -118,7 +117,7 @@ void alsaseq_event_data_note_get_off_velocity(const ALSASeqEventDataNote *self,
 
 /**
  * alsaseq_event_data_note_set_off_velocity:
- * @self: A #ALSASeqEventDataNote.
+ * @self: A [struct@EventDataNote].
  * @off_velocity: The value of note for the off-velocity event.
  *
  * Set the value of note for the off-velocity event.
@@ -131,7 +130,7 @@ void alsaseq_event_data_note_set_off_velocity(ALSASeqEventDataNote *self,
 
 /**
  * alsaseq_event_data_note_get_duration:
- * @self: A #ALSASeqEventDataNote.
+ * @self: A [struct@EventDataNote].
  * @duration: (out): The value of duratino in the note event.
  *
  * Get the value of duration in the note event.
@@ -144,7 +143,7 @@ void alsaseq_event_data_note_get_duration(const ALSASeqEventDataNote *self,
 
 /**
  * alsaseq_event_data_note_set_duration:
- * @self: A #ALSASeqEventDataNote.
+ * @self: A [struct@EventDataNote].
  * @duration: The value of duration for the note event.
  *
  * Set the value of duration for the note event.