proxmox-mirrors/fwupd
1
0
Fork 0
mirror of https://git.proxmox.com/git/fwupd synced 2025-08-08 09:13:22 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

trivial: Fix up some gtk-doc warnings

Browse Source
This commit is contained in:
Richard Hughes 2018-09-04 13:42:26 +01:00 committed by Mario Limonciello
parent 2aa3360d46
commit 828c039c00
8 changed files with 26 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/libfwupd/libfwupd-docs.xml
View File

@ -41,13 +41,15 @@
Functionality available to plugins. Functionality available to plugins.
</para> </para>
</partintro> </partintro>
<xi:include href="xml/fu-plugin.xml"/> <xi:include href="xml/fu-chunk.xml"/>
<xi:include href="xml/fu-device.xml"/>
<xi:include href="xml/fu-usb-device.xml"/>
<xi:include href="xml/fu-device-locker.xml"/>
<xi:include href="xml/fu-common.xml"/> <xi:include href="xml/fu-common.xml"/>
<xi:include href="xml/fu-quirks.xml"/> <xi:include href="xml/fu-device-locker.xml"/>
<xi:include href="xml/fu-device-metadata.xml"/> <xi:include href="xml/fu-device-metadata.xml"/>
<xi:include href="xml/fu-device.xml"/>
<xi:include href="xml/fu-plugin.xml"/>
<xi:include href="xml/fu-quirks.xml"/>
<xi:include href="xml/fu-udev-device.xml"/>
<xi:include href="xml/fu-usb-device.xml"/>
</reference> </reference>
<reference id="tutorial"> <reference id="tutorial">

8
src/fu-chunk.c
View File

@ -69,18 +69,18 @@ fu_chunk_to_string (FuChunk *item)
/** /**
* fu_chunk_array_to_string: * 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. * Converts all the chunked packets in an array to a string representation.
* *
* Return value: (transfer full): A string * Return value: (transfer full): A string
**/ **/
gchar * gchar *
fu_chunk_array_to_string (GPtrArray *segments) fu_chunk_array_to_string (GPtrArray *chunks)
{ {
GString *str = g_string_new (NULL); GString *str = g_string_new (NULL);
for (guint i = 0; i < segments->len; i++) { for (guint i = 0; i < chunks->len; i++) {
FuChunk *item = g_ptr_array_index (segments, i); FuChunk *item = g_ptr_array_index (chunks, i);
g_autofree gchar *tmp = fu_chunk_to_string (item); g_autofree gchar *tmp = fu_chunk_to_string (item);
g_string_append_printf (str, "%s\n", tmp); g_string_append_printf (str, "%s\n", tmp);
} }

2
src/fu-chunk.h
View File

@ -27,7 +27,7 @@ FuChunk *fu_chunk_new (guint32 idx,
guint32 data_sz); guint32 data_sz);
gchar *fu_chunk_to_string (FuChunk *item); 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, GPtrArray *fu_chunk_array_new (const guint8 *data,
guint32 data_sz, guint32 data_sz,
guint32 addr_start, guint32 addr_start,

3
src/fu-device-list.c
View File

@ -136,6 +136,7 @@ fu_device_list_get_active (FuDeviceList *self)
/** /**
* fu_device_list_get_by_platform_id: * fu_device_list_get_by_platform_id:
* @self: A #FuDeviceList * @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 * Returns all the active devices that have been added to the device list
* that match a specific platform ID. * that match a specific platform ID.
@ -605,7 +606,7 @@ fu_device_list_replug_cb (gpointer user_data)
/** /**
* fu_device_list_wait_for_replug: * fu_device_list_wait_for_replug:
* @self: A #FuDeviceList * @self: A #FuDeviceList
* @guid: A device GUID * @device: A #FuDevice
* @error: A #GError, or %NULL * @error: A #GError, or %NULL
* *
* Waits for a specific devic to replug if %FWUPD_DEVICE_FLAG_WAIT_FOR_REPLUG * Waits for a specific devic to replug if %FWUPD_DEVICE_FLAG_WAIT_FOR_REPLUG

6
src/fu-device.c
View File

@ -631,7 +631,7 @@ fu_device_set_firmware_size_min (FuDevice *device, guint64 size_min)
/** /**
* fu_device_set_firmware_size_max: * fu_device_set_firmware_size_max:
* @device: A #FuDevice * @device: A #FuDevice
* @size_min: Size in bytes * @size_max: Size in bytes
* *
* Sets the maximum allowed size of the firmware blob. * 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() * set using fu_device_set_firmware_size_min(), fu_device_set_firmware_size_max()
* or using a quirk entry. * 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 * Since: 1.1.2
**/ **/
@ -1756,7 +1756,7 @@ fu_device_probe_invalidate (FuDevice *device)
/** /**
* fu_device_incorporate: * fu_device_incorporate:
* @device: A #FuDevice * @self: A #FuDevice
* @donor: Another #FuDevice * @donor: Another #FuDevice
* *
* Copy all properties from the donor object if they have not already been set. * Copy all properties from the donor object if they have not already been set.

3
src/fu-engine.c
View File

@ -1230,8 +1230,7 @@ fu_engine_install_tasks (FuEngine *self,
/** /**
* fu_engine_install: * fu_engine_install:
* @self: A #FuEngine * @self: A #FuEngine
* @device: A #FuDevice * @task: A #FuInstallTask
* @app: The #AsApp with the firmware metadata
* @blob_cab: The #GBytes of the .cab file * @blob_cab: The #GBytes of the .cab file
* @flags: The #FwupdInstallFlags, e.g. %FWUPD_DEVICE_FLAG_UPDATABLE * @flags: The #FwupdInstallFlags, e.g. %FWUPD_DEVICE_FLAG_UPDATABLE
* @error: A #GError, or %NULL * @error: A #GError, or %NULL

8
src/fu-plugin.h
View File

@ -128,11 +128,11 @@ void fu_plugin_add_udev_subsystem (FuPlugin *plugin,
const gchar *subsystem); const gchar *subsystem);
FuQuirks *fu_plugin_get_quirks (FuPlugin *plugin); FuQuirks *fu_plugin_get_quirks (FuPlugin *plugin);
const gchar *fu_plugin_lookup_quirk_by_id (FuPlugin *plugin, const gchar *fu_plugin_lookup_quirk_by_id (FuPlugin *plugin,
const gchar *prefix, const gchar *group,
const gchar *id); const gchar *key);
guint64 fu_plugin_lookup_quirk_by_id_as_uint64 (FuPlugin *plugin, guint64 fu_plugin_lookup_quirk_by_id_as_uint64 (FuPlugin *plugin,
const gchar *prefix, const gchar *group,
const gchar *id); const gchar *key);
void fu_plugin_add_report_metadata (FuPlugin *plugin, void fu_plugin_add_report_metadata (FuPlugin *plugin,
const gchar *key, const gchar *key,
const gchar *value); const gchar *value);

8
src/fu-udev-device.c
View File

@ -221,7 +221,7 @@ fu_udev_device_get_dev (FuUdevDevice *self)
/** /**
* fu_udev_device_get_subsystem: * fu_udev_device_get_subsystem:
* @udev_device: A #GUdevDevice * @self: A #GUdevDevice
* *
* Gets the device subsystem, e.g. "pci". * Gets the device subsystem, e.g. "pci".
* *
@ -239,7 +239,7 @@ fu_udev_device_get_subsystem (FuUdevDevice *self)
/** /**
* fu_udev_device_get_vendor: * fu_udev_device_get_vendor:
* @udev_device: A #GUdevDevice * @self: A #GUdevDevice
* *
* Gets the device vendor code. * Gets the device vendor code.
* *
@ -257,7 +257,7 @@ fu_udev_device_get_vendor (FuUdevDevice *self)
/** /**
* fu_udev_device_get_model: * fu_udev_device_get_model:
* @udev_device: A #GUdevDevice * @self: A #GUdevDevice
* *
* Gets the device device code. * Gets the device device code.
* *
@ -275,7 +275,7 @@ fu_udev_device_get_model (FuUdevDevice *self)
/** /**
* fu_udev_device_get_revision: * fu_udev_device_get_revision:
* @udev_device: A #GUdevDevice * @self: A #GUdevDevice
* *
* Gets the device revision. * Gets the device revision.
* *