From: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Date: Wed, 22 Apr 2020 03:14:09 +0000 (+0900)
Subject: seq: event_data_queue/event_fixed: improve annotation for byte methods
X-Git-Tag: v0.1.0~149
X-Git-Url: https://git.alsa-project.org/?a=commitdiff_plain;h=7de590205d6ee57e98dc8f3320c303730f4da000;p=alsa-gobject.git

seq: event_data_queue/event_fixed: improve annotation for byte methods

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
---

diff --git a/src/seq/event-data-queue.c b/src/seq/event-data-queue.c
index 48fa015..0c19f0e 100644
--- a/src/seq/event-data-queue.c
+++ b/src/seq/event-data-queue.c
@@ -178,10 +178,10 @@ void alsaseq_event_data_queue_set_quadlet_param(ALSASeqEventDataQueue *self,
 /**
  * alsaseq_event_data_queue_get_byte_param:
  * @self: A #ALSASeqEventDataQueue.
- * @bytes: (array fixed-size=8)(out)(transfer none): Eight bytes as param of the
- *          queue event.
+ * @bytes: (array fixed-size=8)(out)(transfer none): The array with eight
+ *         elements for bytes parameter of the queue event.
  *
- * Get eight bytes as param of the queue event.
+ * Refer to eight bytes as the parameter of queue event.
  */
 void alsaseq_event_data_queue_get_byte_param(ALSASeqEventDataQueue *self,
                                              const guint8 *bytes[8])
@@ -192,10 +192,10 @@ void alsaseq_event_data_queue_get_byte_param(ALSASeqEventDataQueue *self,
 /**
  * alsaseq_event_data_queue_set_byte_param:
  * @self: A #ALSASeqEventDataQueue.
- * @bytes: (array fixed-size=8)(transfer none): eight bytes as param of the
- *        queue event.
+ * @bytes: (array fixed-size=8)(transfer none): The array with eight elements
+ *         for bytes parameter of the queue event.
  *
- * Set eight quadlets as param of the queue event.
+ * Copy eight bytes from the given buffer as the parameter of queue event.
  */
 void alsaseq_event_data_queue_set_byte_param(ALSASeqEventDataQueue *self,
                                              const guint8 bytes[8])
diff --git a/src/seq/event-fixed.c b/src/seq/event-fixed.c
index 257f806..9ca2fe7 100644
--- a/src/seq/event-fixed.c
+++ b/src/seq/event-fixed.c
@@ -218,10 +218,10 @@ ALSASeqEventFixed *alsaseq_event_fixed_new(ALSASeqEventType event_type,
 /**
  * alsaseq_event_fixed_get_byte_data:
  * @self: A #ALSASeqEventFixed.
- * @bytes: (array fixed-size=12)(out)(transfer none): The 12 byte data for the
- *         event. The lifetime of the object is the same as the event itself.
+ * @bytes: (array fixed-size=12)(out)(transfer none): The array with twelve
+ *         elements for byte data of the event.
  *
- * Refer to the 12 byte data for the event.
+ * Refer to the twelve bytes as the data of event.
  */
 void alsaseq_event_fixed_get_byte_data(ALSASeqEventFixed *self,
                                        const guint8 *bytes[12])
@@ -239,9 +239,10 @@ void alsaseq_event_fixed_get_byte_data(ALSASeqEventFixed *self,
 /**
  * alsaseq_event_fixed_set_byte_data:
  * @self: A #ALSASeqEventFixed.
- * @bytes: (array fixed-size=12)(transfer none): The 12 byte data for the event.
+ * @bytes: (array fixed-size=12)(transfer none): The array with twelve elements
+ *         for byte data of the event.
  *
- * Copy the 12 byte data for the event.
+ * Copy the twelve bytes from the given buffer as the data of event.
  */
 void alsaseq_event_fixed_set_byte_data(ALSASeqEventFixed *self,
                                        const guint8 bytes[12])