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

seq: event_data_queue/event_fixed: improve annotations for quadlets 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 0c19f0e..19e1164 100644
--- a/src/seq/event-data-queue.c
+++ b/src/seq/event-data-queue.c
@@ -150,10 +150,10 @@ void alsaseq_event_data_queue_set_skew_param(ALSASeqEventDataQueue *self,
 /**
  * alsaseq_event_data_queue_get_quadlet_param:
  * @self: A #ALSASeqEventDataQueue.
- * @quadlets: (array fixed-size=2)(out)(transfer none): Two quadlets as param of
- *            the queue event.
+ * @quadlets: (array fixed-size=2)(out)(transfer none): The array with two
+ *            elements for quadlets as the parameter of queue event.
  *
- * Get two quadlets as param of the queue event.
+ * Refer to two quadlets as the parameter of queue event.
  */
 void alsaseq_event_data_queue_get_quadlet_param(ALSASeqEventDataQueue *self,
                                                 const guint32 *quadlets[2])
@@ -164,10 +164,10 @@ void alsaseq_event_data_queue_get_quadlet_param(ALSASeqEventDataQueue *self,
 /**
  * alsaseq_event_data_queue_set_quadlet_param:
  * @self: A #ALSASeqEventDataQueue.
- * @quadlets: (array fixed-size=2)(transfer none): Two quadlets as param of the
- *            queue event.
+ * @quadlets: (array fixed-size=2)(transfer none): The array with two elements
+ *            for quadlets as the parameter of queue event.
  *
- * Set two quadlets as param of the queue event.
+ * Set two quadlets from the given buffer as the parameter of queue event.
  */
 void alsaseq_event_data_queue_set_quadlet_param(ALSASeqEventDataQueue *self,
                                                 const guint32 quadlets[2])
diff --git a/src/seq/event-fixed.c b/src/seq/event-fixed.c
index 9ca2fe7..92c81c6 100644
--- a/src/seq/event-fixed.c
+++ b/src/seq/event-fixed.c
@@ -260,11 +260,10 @@ void alsaseq_event_fixed_set_byte_data(ALSASeqEventFixed *self,
 /**
  * alsaseq_event_fixed_get_quadlet_data:
  * @self: A #ALSASeqEventFixed.
- * @quadlets: (array fixed-size=3)(out)(transfer none): The 3 quadlet data for
- *            the event. The lifetime of the object is the same as the event
- *            itself.
+ * @quadlets: (array fixed-size=3)(out)(transfer none): The array with three
+ *            elements for quadlets as the data of event.
  *
- * Get the 3 quadlet data for the event.
+ * Refer to three quadlet as the data of event.
  */
 void alsaseq_event_fixed_get_quadlet_data(ALSASeqEventFixed *self,
                                           const guint32 *quadlets[3])
@@ -282,10 +281,10 @@ void alsaseq_event_fixed_get_quadlet_data(ALSASeqEventFixed *self,
 /**
  * alsaseq_event_fixed_set_quadlet_data:
  * @self: A #ALSASeqEventFixed.
- * @quadlets: (array fixed-size=3)(transfer none): The 3 quadlet data for the
- *            event.
+ * @quadlets: (array fixed-size=3)(transfer none): The array with three elements
+ *            for quadlets for the data of event.
  *
- * Copy the 3 quadlet data for the event.
+ * Copy three quadlets from the given buffer as the data of event.
  */
 void alsaseq_event_fixed_set_quadlet_data(ALSASeqEventFixed *self,
                                           const guint32 quadlets[3])