summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorElmar Hoffmann <elho@elho.net>2020-06-15 19:21:38 +0200
committerRichard Hughes <richard@hughsie.com>2020-06-15 19:02:16 +0100
commitb87cd436a5435b7f6ccaceba076b58e4481e8802 (patch)
treec0d4f5e88e952e014c3c41a983d939a4b6f0d6ae
parent4534c166c1f65fc0a032b2718a41571021ae88fb (diff)
downloadcolord-b87cd436a5435b7f6ccaceba076b58e4481e8802.tar.gz
fix more annotation for data arrays
-rw-r--r--lib/colord/cd-buffer.c2
-rw-r--r--lib/colord/cd-dom.c2
-rw-r--r--lib/colord/cd-it8.c4
-rw-r--r--lib/colorhug/ch-common.c2
-rw-r--r--lib/colorhug/ch-device-queue.c82
-rw-r--r--lib/colorhug/ch-device.c2
6 files changed, 47 insertions, 47 deletions
diff --git a/lib/colord/cd-buffer.c b/lib/colord/cd-buffer.c
index 1cdae08..f26f09b 100644
--- a/lib/colord/cd-buffer.c
+++ b/lib/colord/cd-buffer.c
@@ -167,7 +167,7 @@ cd_buffer_read_uint32_le (const guint8 *buffer)
/**
* cd_buffer_debug:
* @buffer_kind: the debug mode, e.g %CD_BUFFER_KIND_REQUEST
- * @data: the data of size @length
+ * @data: (array length=length): the data of size @length
* @length: the size of data
*
* Prints some debugging of the request to the console.
diff --git a/lib/colord/cd-dom.c b/lib/colord/cd-dom.c
index 7d83bc8..110e912 100644
--- a/lib/colord/cd-dom.c
+++ b/lib/colord/cd-dom.c
@@ -199,7 +199,7 @@ cd_dom_text_cb (GMarkupParseContext *context,
/**
* cd_dom_parse_xml_data:
* @dom: a #CdDom instance.
- * @data: XML data
+ * @data: (array length=data_len): XML data
* @data_len: Length of @data, or -1 if NULL terminated
* @error: A #GError or %NULL
*
diff --git a/lib/colord/cd-it8.c b/lib/colord/cd-it8.c
index b71ad39..cd91783 100644
--- a/lib/colord/cd-it8.c
+++ b/lib/colord/cd-it8.c
@@ -828,7 +828,7 @@ cd_it8_has_option (CdIt8 *it8, const gchar *option)
/**
* cd_it8_load_from_data:
* @it8: a #CdIt8 instance.
- * @data: text data
+ * @data: (array length=size): text data
* @size: the size of text data
* @error: a #GError, or %NULL
*
@@ -1347,7 +1347,7 @@ cd_it8_save_to_file_ccss_sp (CdIt8 *it8, cmsHANDLE it8_lcms, GError **error)
/**
* cd_it8_save_to_data:
* @it8: a #CdIt8 instance.
- * @data: a pointer to returned data
+ * @data: (array length=size): a pointer to returned data
* @size: size of @data
* @error: a #GError, or %NULL
*
diff --git a/lib/colorhug/ch-common.c b/lib/colorhug/ch-common.c
index f18de69..3bcc4b0 100644
--- a/lib/colorhug/ch-common.c
+++ b/lib/colorhug/ch-common.c
@@ -448,7 +448,7 @@ ch_device_mode_to_string (ChDeviceMode device_mode)
/**
* ch_device_mode_from_firmware:
- * @data: firmware binary data
+ * @data: (array length=data_len): firmware binary data
* @data_len: size of @data
*
* Gets the device mode from the unique code stored in the firmware data.
diff --git a/lib/colorhug/ch-device-queue.c b/lib/colorhug/ch-device-queue.c
index 18075b2..5f7a4eb 100644
--- a/lib/colorhug/ch-device-queue.c
+++ b/lib/colorhug/ch-device-queue.c
@@ -1150,10 +1150,10 @@ ch_device_queue_set_calibration_ccmx (ChDeviceQueue *device_queue,
/**
* ch_device_queue_write_firmware:
- * @device_queue: A #ChDeviceQueue
- * @device: A #GUsbDevice
- * @data: Firmware binary data
- * @len: Size of @data
+ * @device_queue: A #ChDeviceQueue
+ * @device: A #GUsbDevice
+ * @data: (array length=len): Firmware binary data
+ * @len: Size of @data
*
* Writes new firmware to the device.
*
@@ -1206,10 +1206,10 @@ ch_device_queue_write_firmware (ChDeviceQueue *device_queue,
/**
* ch_device_queue_verify_firmware:
- * @device_queue: A #ChDeviceQueue
- * @device: A #GUsbDevice
- * @data: Firmware binary data
- * @len: Size of @data
+ * @device_queue: A #ChDeviceQueue
+ * @device: A #GUsbDevice
+ * @data: (array length=len): Firmware binary data
+ * @len: Size of @data
*
* Verifies firmware on the device.
*
@@ -1252,10 +1252,10 @@ ch_device_queue_verify_firmware (ChDeviceQueue *device_queue,
/**
* ch_device_queue_read_firmware:
- * @device_queue: A #ChDeviceQueue
- * @device: A #GUsbDevice
- * @data: Firmware binary data
- * @len: Size of @data
+ * @device_queue: A #ChDeviceQueue
+ * @device: A #GUsbDevice
+ * @data: (array length=len): Firmware binary data
+ * @len: Size of @data
*
* Reads firmware on the device.
*
@@ -2388,11 +2388,11 @@ ch_device_queue_calculate_checksum (const guint8 *data,
/**
* ch_device_queue_write_flash:
- * @device_queue: A #ChDeviceQueue
- * @device: A #GUsbDevice
- * @address: The device EEPROM address
- * @data: Binary data
- * @len: The length of @data
+ * @device_queue: A #ChDeviceQueue
+ * @device: A #GUsbDevice
+ * @address: The device EEPROM address
+ * @data: (array length=len): Binary data
+ * @len: The length of @data
*
* Write flash code to the device.
*
@@ -2467,11 +2467,11 @@ ch_device_queue_buffer_read_flash_cb (guint8 *output_buffer,
/**
* ch_device_queue_read_flash:
- * @device_queue: A #ChDeviceQueue
- * @device: A #GUsbDevice
- * @address: The device EEPROM address
- * @data: Binary data
- * @len: The length of @data
+ * @device_queue: A #ChDeviceQueue
+ * @device: A #GUsbDevice
+ * @address: The device EEPROM address
+ * @data: (array length=len): Binary data
+ * @len: The length of @data
*
* Read flash code from the device.
*
@@ -2569,11 +2569,11 @@ ch_device_queue_verify_flash_helper_destroy (gpointer data)
/**
* ch_device_queue_verify_flash:
- * @device_queue: A #ChDeviceQueue
- * @device: A #GUsbDevice
- * @address: The device EEPROM address
- * @data: Binary data
- * @len: The length of @data
+ * @device_queue: A #ChDeviceQueue
+ * @device: A #GUsbDevice
+ * @address: The device EEPROM address
+ * @data: (array length=len): Binary data
+ * @len: The length of @data
*
* Verify flash code from the device.
*
@@ -2621,10 +2621,10 @@ ch_device_queue_verify_flash (ChDeviceQueue *device_queue,
/**
* ch_device_queue_erase_flash:
- * @device_queue: A #ChDeviceQueue
- * @device: A #GUsbDevice
- * @address: The device EEPROM address
- * @len: The length of @data
+ * @device_queue: A #ChDeviceQueue
+ * @device: A #GUsbDevice
+ * @address: (array length=len): The device EEPROM address
+ * @len: The length of @data
*
* Erase program code on the device.
*
@@ -3019,11 +3019,11 @@ ch_device_queue_write_sram_internal (ChDeviceQueue *device_queue,
/**
* ch_device_queue_write_sram:
- * @device_queue: A #ChDeviceQueue
- * @device: A #GUsbDevice
- * @address: The device memory address
- * @data: The binary data
- * @len: Size of @data
+ * @device_queue: A #ChDeviceQueue
+ * @device: A #GUsbDevice
+ * @address: The device memory address
+ * @data: (array length=len): The binary data
+ * @len: Size of @data
*
* Writes binary data to the SRAM.
*
@@ -3087,11 +3087,11 @@ ch_device_queue_read_sram_internal (ChDeviceQueue *device_queue,
/**
* ch_device_queue_read_sram:
- * @device_queue: A #ChDeviceQueue
- * @device: A #GUsbDevice
- * @address: The device memory address
- * @data: The binary data
- * @len: Size of @data
+ * @device_queue: A #ChDeviceQueue
+ * @device: A #GUsbDevice
+ * @address: The device memory address
+ * @data: (array length=len): The binary data
+ * @len: Size of @data
*
* Reads binary data from the SRAM.
*
diff --git a/lib/colorhug/ch-device.c b/lib/colorhug/ch-device.c
index 3f58040..f63b538 100644
--- a/lib/colorhug/ch-device.c
+++ b/lib/colorhug/ch-device.c
@@ -764,7 +764,7 @@ ch_device_write_command (GUsbDevice *device,
/**
* ch_device_check_firmware:
- * @data: firmware binary data
+ * @data: (array length=data_len): firmware binary data
* @data_len: size of @data
*
* Checks the firmware is suitable for the ColorHug device that is attached.