From 828c039c00bc4e027a5014d1fa4c2f9838ec5fd2 Mon Sep 17 00:00:00 2001 From: Richard Hughes Date: Tue, 4 Sep 2018 13:42:26 +0100 Subject: [PATCH] trivial: Fix up some gtk-doc warnings --- docs/libfwupd/libfwupd-docs.xml | 12 +++++++----- src/fu-chunk.c | 8 ++++---- src/fu-chunk.h | 2 +- src/fu-device-list.c | 3 ++- src/fu-device.c | 6 +++--- src/fu-engine.c | 3 +-- src/fu-plugin.h | 8 ++++---- src/fu-udev-device.c | 8 ++++---- 8 files changed, 26 insertions(+), 24 deletions(-) diff --git a/docs/libfwupd/libfwupd-docs.xml b/docs/libfwupd/libfwupd-docs.xml index a7d1ccbf8..ad4d01e39 100644 --- a/docs/libfwupd/libfwupd-docs.xml +++ b/docs/libfwupd/libfwupd-docs.xml @@ -41,13 +41,15 @@ Functionality available to plugins. - - - - + - + + + + + + diff --git a/src/fu-chunk.c b/src/fu-chunk.c index 8219eed74..c13cab7b9 100644 --- a/src/fu-chunk.c +++ b/src/fu-chunk.c @@ -69,18 +69,18 @@ fu_chunk_to_string (FuChunk *item) /** * fu_chunk_array_to_string: - * @segments: (element-type FuChunk): array of packets + * @chunks: (element-type FuChunk): array of packets * * Converts all the chunked packets in an array to a string representation. * * Return value: (transfer full): A string **/ gchar * -fu_chunk_array_to_string (GPtrArray *segments) +fu_chunk_array_to_string (GPtrArray *chunks) { GString *str = g_string_new (NULL); - for (guint i = 0; i < segments->len; i++) { - FuChunk *item = g_ptr_array_index (segments, i); + for (guint i = 0; i < chunks->len; i++) { + FuChunk *item = g_ptr_array_index (chunks, i); g_autofree gchar *tmp = fu_chunk_to_string (item); g_string_append_printf (str, "%s\n", tmp); } diff --git a/src/fu-chunk.h b/src/fu-chunk.h index 304d0c8e7..74eedd3fa 100644 --- a/src/fu-chunk.h +++ b/src/fu-chunk.h @@ -27,7 +27,7 @@ FuChunk *fu_chunk_new (guint32 idx, guint32 data_sz); gchar *fu_chunk_to_string (FuChunk *item); -gchar *fu_chunk_array_to_string (GPtrArray *chunked); +gchar *fu_chunk_array_to_string (GPtrArray *chunks); GPtrArray *fu_chunk_array_new (const guint8 *data, guint32 data_sz, guint32 addr_start, diff --git a/src/fu-device-list.c b/src/fu-device-list.c index 14f2d97e2..717f01a21 100644 --- a/src/fu-device-list.c +++ b/src/fu-device-list.c @@ -136,6 +136,7 @@ fu_device_list_get_active (FuDeviceList *self) /** * fu_device_list_get_by_platform_id: * @self: A #FuDeviceList + * @platform_id: A platform ID, e.g. `/sys/devices/usb1/1-1/1-1.2` * * Returns all the active devices that have been added to the device list * that match a specific platform ID. @@ -605,7 +606,7 @@ fu_device_list_replug_cb (gpointer user_data) /** * fu_device_list_wait_for_replug: * @self: A #FuDeviceList - * @guid: A device GUID + * @device: A #FuDevice * @error: A #GError, or %NULL * * Waits for a specific devic to replug if %FWUPD_DEVICE_FLAG_WAIT_FOR_REPLUG diff --git a/src/fu-device.c b/src/fu-device.c index adc844ba9..8cbe39f15 100644 --- a/src/fu-device.c +++ b/src/fu-device.c @@ -631,7 +631,7 @@ fu_device_set_firmware_size_min (FuDevice *device, guint64 size_min) /** * fu_device_set_firmware_size_max: * @device: A #FuDevice - * @size_min: Size in bytes + * @size_max: Size in bytes * * Sets the maximum allowed size of the firmware blob. * @@ -1414,7 +1414,7 @@ fu_device_write_firmware (FuDevice *device, GBytes *fw, GError **error) * set using fu_device_set_firmware_size_min(), fu_device_set_firmware_size_max() * or using a quirk entry. * - * Returns: (return full): A new #GBytes, or %NULL for error + * Returns: (transfer full): A new #GBytes, or %NULL for error * * Since: 1.1.2 **/ @@ -1756,7 +1756,7 @@ fu_device_probe_invalidate (FuDevice *device) /** * fu_device_incorporate: - * @device: A #FuDevice + * @self: A #FuDevice * @donor: Another #FuDevice * * Copy all properties from the donor object if they have not already been set. diff --git a/src/fu-engine.c b/src/fu-engine.c index 1f7911fa6..ba4d3d997 100644 --- a/src/fu-engine.c +++ b/src/fu-engine.c @@ -1230,8 +1230,7 @@ fu_engine_install_tasks (FuEngine *self, /** * fu_engine_install: * @self: A #FuEngine - * @device: A #FuDevice - * @app: The #AsApp with the firmware metadata + * @task: A #FuInstallTask * @blob_cab: The #GBytes of the .cab file * @flags: The #FwupdInstallFlags, e.g. %FWUPD_DEVICE_FLAG_UPDATABLE * @error: A #GError, or %NULL diff --git a/src/fu-plugin.h b/src/fu-plugin.h index efd1e5876..c50025228 100644 --- a/src/fu-plugin.h +++ b/src/fu-plugin.h @@ -128,11 +128,11 @@ void fu_plugin_add_udev_subsystem (FuPlugin *plugin, const gchar *subsystem); FuQuirks *fu_plugin_get_quirks (FuPlugin *plugin); const gchar *fu_plugin_lookup_quirk_by_id (FuPlugin *plugin, - const gchar *prefix, - const gchar *id); + const gchar *group, + const gchar *key); guint64 fu_plugin_lookup_quirk_by_id_as_uint64 (FuPlugin *plugin, - const gchar *prefix, - const gchar *id); + const gchar *group, + const gchar *key); void fu_plugin_add_report_metadata (FuPlugin *plugin, const gchar *key, const gchar *value); diff --git a/src/fu-udev-device.c b/src/fu-udev-device.c index 9ff7d4664..f59b32fd0 100644 --- a/src/fu-udev-device.c +++ b/src/fu-udev-device.c @@ -221,7 +221,7 @@ fu_udev_device_get_dev (FuUdevDevice *self) /** * fu_udev_device_get_subsystem: - * @udev_device: A #GUdevDevice + * @self: A #GUdevDevice * * Gets the device subsystem, e.g. "pci". * @@ -239,7 +239,7 @@ fu_udev_device_get_subsystem (FuUdevDevice *self) /** * fu_udev_device_get_vendor: - * @udev_device: A #GUdevDevice + * @self: A #GUdevDevice * * Gets the device vendor code. * @@ -257,7 +257,7 @@ fu_udev_device_get_vendor (FuUdevDevice *self) /** * fu_udev_device_get_model: - * @udev_device: A #GUdevDevice + * @self: A #GUdevDevice * * Gets the device device code. * @@ -275,7 +275,7 @@ fu_udev_device_get_model (FuUdevDevice *self) /** * fu_udev_device_get_revision: - * @udev_device: A #GUdevDevice + * @self: A #GUdevDevice * * Gets the device revision. *