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

trivial: Standardize on introspection for @error and @cancellable

Browse Source 
Also standarize on `Returns:` for the result.
This commit is contained in:
Richard Hughes 2021-04-28 14:52:10 +01:00
parent 7b23f95a21
commit 89d45a0d91
47 changed files with 542 additions and 542 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

160
libfwupd/fwupd-client-sync.c
View File

@ -78,8 +78,8 @@ fwupd_client_connect_cb (GObject *source, GAsyncResult *res, gpointer user_data)
/** /**
* fwupd_client_connect: * fwupd_client_connect:
* @self: A #FwupdClient * @self: A #FwupdClient
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Sets up the client ready for use. Most other methods call this * Sets up the client ready for use. Most other methods call this
* for you, and do you only need to call this if you are just watching * for you, and do you only need to call this if you are just watching
@ -120,8 +120,8 @@ fwupd_client_get_devices_cb (GObject *source, GAsyncResult *res, gpointer user_d
/** /**
* fwupd_client_get_devices: * fwupd_client_get_devices:
* @self: A #FwupdClient * @self: A #FwupdClient
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets all the devices registered with the daemon. * Gets all the devices registered with the daemon.
* *
@ -165,8 +165,8 @@ fwupd_client_get_plugins_cb (GObject *source, GAsyncResult *res, gpointer user_d
/** /**
* fwupd_client_get_plugins: * fwupd_client_get_plugins:
* @self: A #FwupdClient * @self: A #FwupdClient
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets all the plugins being used the daemon. * Gets all the plugins being used the daemon.
* *
@ -210,8 +210,8 @@ fwupd_client_get_history_cb (GObject *source, GAsyncResult *res, gpointer user_d
/** /**
* fwupd_client_get_history: * fwupd_client_get_history:
* @self: A #FwupdClient * @self: A #FwupdClient
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets all the history. * Gets all the history.
* *
@ -256,8 +256,8 @@ fwupd_client_get_releases_cb (GObject *source, GAsyncResult *res, gpointer user_
* fwupd_client_get_releases: * fwupd_client_get_releases:
* @self: A #FwupdClient * @self: A #FwupdClient
* @device_id: the device ID * @device_id: the device ID
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets all the releases for a specific device * Gets all the releases for a specific device
* *
@ -304,8 +304,8 @@ fwupd_client_get_downgrades_cb (GObject *source, GAsyncResult *res, gpointer use
* fwupd_client_get_downgrades: * fwupd_client_get_downgrades:
* @self: A #FwupdClient * @self: A #FwupdClient
* @device_id: the device ID * @device_id: the device ID
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets all the downgrades for a specific device. * Gets all the downgrades for a specific device.
* *
@ -352,8 +352,8 @@ fwupd_client_get_upgrades_cb (GObject *source, GAsyncResult *res, gpointer user_
* fwupd_client_get_upgrades: * fwupd_client_get_upgrades:
* @self: A #FwupdClient * @self: A #FwupdClient
* @device_id: the device ID * @device_id: the device ID
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets all the upgrades for a specific device. * Gets all the upgrades for a specific device.
* *
@ -400,8 +400,8 @@ fwupd_client_get_details_bytes_cb (GObject *source, GAsyncResult *res, gpointer
* fwupd_client_get_details_bytes: * fwupd_client_get_details_bytes:
* @self: A #FwupdClient * @self: A #FwupdClient
* @bytes: the firmware blob, e.g. the contents of `firmware.cab` * @bytes: the firmware blob, e.g. the contents of `firmware.cab`
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets details about a specific firmware file. * Gets details about a specific firmware file.
* *
@ -454,8 +454,8 @@ fwupd_client_get_details_cb (GObject *source, GAsyncResult *res, gpointer user_d
* fwupd_client_get_details: * fwupd_client_get_details:
* @self: A #FwupdClient * @self: A #FwupdClient
* @filename: the firmware filename, e.g. `firmware.cab` * @filename: the firmware filename, e.g. `firmware.cab`
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets details about a specific firmware file. * Gets details about a specific firmware file.
* *
@ -517,8 +517,8 @@ fwupd_client_verify_cb (GObject *source, GAsyncResult *res, gpointer user_data)
* fwupd_client_verify: * fwupd_client_verify:
* @self: A #FwupdClient * @self: A #FwupdClient
* @device_id: the device ID * @device_id: the device ID
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Verify a specific device. * Verify a specific device.
* *
@ -568,8 +568,8 @@ fwupd_client_verify_update_cb (GObject *source, GAsyncResult *res, gpointer user
* fwupd_client_verify_update: * fwupd_client_verify_update:
* @self: A #FwupdClient * @self: A #FwupdClient
* @device_id: the device ID * @device_id: the device ID
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Update the verification record for a specific device. * Update the verification record for a specific device.
* *
@ -619,8 +619,8 @@ fwupd_client_unlock_cb (GObject *source, GAsyncResult *res, gpointer user_data)
* fwupd_client_unlock: * fwupd_client_unlock:
* @self: A #FwupdClient * @self: A #FwupdClient
* @device_id: the device ID * @device_id: the device ID
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Unlocks a specific device so firmware can be read or wrote. * Unlocks a specific device so firmware can be read or wrote.
* *
@ -670,8 +670,8 @@ fwupd_client_modify_config_cb (GObject *source, GAsyncResult *res, gpointer user
* @self: A #FwupdClient * @self: A #FwupdClient
* @key: key, e.g. `DisabledPlugins` * @key: key, e.g. `DisabledPlugins`
* @value: value, e.g. `*` * @value: value, e.g. `*`
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Modifies a daemon config option. * Modifies a daemon config option.
* The daemon will only respond to this request with proper permissions * The daemon will only respond to this request with proper permissions
@ -724,9 +724,9 @@ fwupd_client_activate_cb (GObject *source, GAsyncResult *res, gpointer user_data
/** /**
* fwupd_client_activate: * fwupd_client_activate:
* @self: A #FwupdClient * @self: A #FwupdClient
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @device_id: a device * @device_id: a device
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Activates up a device, which normally means the device switches to a new * Activates up a device, which normally means the device switches to a new
* firmware version. This should only be called when data loss cannot occur. * firmware version. This should only be called when data loss cannot occur.
@ -778,8 +778,8 @@ fwupd_client_clear_results_cb (GObject *source, GAsyncResult *res, gpointer user
* fwupd_client_clear_results: * fwupd_client_clear_results:
* @self: A #FwupdClient * @self: A #FwupdClient
* @device_id: the device ID * @device_id: the device ID
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Clears the results for a specific device. * Clears the results for a specific device.
* *
@ -830,8 +830,8 @@ fwupd_client_get_results_cb (GObject *source, GAsyncResult *res, gpointer user_d
* fwupd_client_get_results: * fwupd_client_get_results:
* @self: A #FwupdClient * @self: A #FwupdClient
* @device_id: the device ID * @device_id: the device ID
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the results of a previous firmware update for a specific device. * Gets the results of a previous firmware update for a specific device.
* *
@ -877,8 +877,8 @@ fwupd_client_get_host_security_attrs_cb (GObject *source, GAsyncResult *res, gpo
/** /**
* fwupd_client_get_host_security_attrs: * fwupd_client_get_host_security_attrs:
* @self: A #FwupdClient * @self: A #FwupdClient
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets all the host security attributes from the daemon. * Gets all the host security attributes from the daemon.
* *
@ -926,8 +926,8 @@ fwupd_client_get_device_by_id_cb (GObject *source, GAsyncResult *res, gpointer u
* fwupd_client_get_device_by_id: * fwupd_client_get_device_by_id:
* @self: A #FwupdClient * @self: A #FwupdClient
* @device_id: the device ID, e.g. `usb:00:01:03:03` * @device_id: the device ID, e.g. `usb:00:01:03:03`
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets a device by it's device ID. * Gets a device by it's device ID.
* *
@ -977,8 +977,8 @@ fwupd_client_get_devices_by_guid_cb (GObject *source, GAsyncResult *res, gpointe
* fwupd_client_get_devices_by_guid: * fwupd_client_get_devices_by_guid:
* @self: A #FwupdClient * @self: A #FwupdClient
* @guid: the GUID, e.g. `e22c4520-43dc-5bb3-8245-5787fead9b63` * @guid: the GUID, e.g. `e22c4520-43dc-5bb3-8245-5787fead9b63`
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets any devices that provide a specific GUID. An error is returned if no * Gets any devices that provide a specific GUID. An error is returned if no
* devices contains this GUID. * devices contains this GUID.
@ -1031,8 +1031,8 @@ fwupd_client_install_fd_cb (GObject *source, GAsyncResult *res, gpointer user_da
* @device_id: the device ID * @device_id: the device ID
* @filename: the filename to install * @filename: the filename to install
* @install_flags: the #FwupdInstallFlags, e.g. %FWUPD_INSTALL_FLAG_ALLOW_REINSTALL * @install_flags: the #FwupdInstallFlags, e.g. %FWUPD_INSTALL_FLAG_ALLOW_REINSTALL
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Install a file onto a specific device. * Install a file onto a specific device.
* *
@ -1102,8 +1102,8 @@ fwupd_client_install_bytes_cb (GObject *source, GAsyncResult *res, gpointer user
* @device_id: the device ID * @device_id: the device ID
* @bytes: #GBytes * @bytes: #GBytes
* @install_flags: the #FwupdInstallFlags, e.g. %FWUPD_INSTALL_FLAG_ALLOW_REINSTALL * @install_flags: the #FwupdInstallFlags, e.g. %FWUPD_INSTALL_FLAG_ALLOW_REINSTALL
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Install firmware onto a specific device. * Install firmware onto a specific device.
* *
@ -1159,8 +1159,8 @@ fwupd_client_install_release_cb (GObject *source, GAsyncResult *res, gpointer us
* @release: A #FwupdRelease * @release: A #FwupdRelease
* @install_flags: the #FwupdInstallFlags, e.g. %FWUPD_INSTALL_FLAG_ALLOW_REINSTALL * @install_flags: the #FwupdInstallFlags, e.g. %FWUPD_INSTALL_FLAG_ALLOW_REINSTALL
* @download_flags: the #FwupdClientDownloadFlags, e.g. %FWUPD_CLIENT_DOWNLOAD_FLAG_NONE * @download_flags: the #FwupdClientDownloadFlags, e.g. %FWUPD_CLIENT_DOWNLOAD_FLAG_NONE
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Installs a new release on a device, downloading the firmware if required. * Installs a new release on a device, downloading the firmware if required.
* *
@ -1210,8 +1210,8 @@ fwupd_client_install_release2 (FwupdClient *self,
* @device: A #FwupdDevice * @device: A #FwupdDevice
* @release: A #FwupdRelease * @release: A #FwupdRelease
* @install_flags: the #FwupdInstallFlags, e.g. %FWUPD_INSTALL_FLAG_ALLOW_REINSTALL * @install_flags: the #FwupdInstallFlags, e.g. %FWUPD_INSTALL_FLAG_ALLOW_REINSTALL
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Installs a new release on a device, downloading the firmware if required. * Installs a new release on a device, downloading the firmware if required.
* *
@ -1249,8 +1249,8 @@ fwupd_client_update_metadata_cb (GObject *source, GAsyncResult *res, gpointer us
* @remote_id: the remote ID, e.g. `lvfs-testing` * @remote_id: the remote ID, e.g. `lvfs-testing`
* @metadata_fn: the XML metadata filename * @metadata_fn: the XML metadata filename
* @signature_fn: the GPG signature file * @signature_fn: the GPG signature file
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Updates the metadata. This allows a session process to download the metadata * Updates the metadata. This allows a session process to download the metadata
* and metadata signing file to be passed into the daemon to be checked and * and metadata signing file to be passed into the daemon to be checked and
@ -1328,8 +1328,8 @@ fwupd_client_update_metadata_bytes_cb (GObject *source, GAsyncResult *res, gpoin
* @remote_id: remote ID, e.g. `lvfs-testing` * @remote_id: remote ID, e.g. `lvfs-testing`
* @metadata: XML metadata data * @metadata: XML metadata data
* @signature: signature data * @signature: signature data
* @cancellable: #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Updates the metadata. This allows a session process to download the metadata * Updates the metadata. This allows a session process to download the metadata
* and metadata signing file to be passed into the daemon to be checked and * and metadata signing file to be passed into the daemon to be checked and
@ -1392,8 +1392,8 @@ fwupd_client_refresh_remote_cb (GObject *source,
* fwupd_client_refresh_remote: * fwupd_client_refresh_remote:
* @self: A #FwupdClient * @self: A #FwupdClient
* @remote: A #FwupdRemote * @remote: A #FwupdRemote
* @cancellable: A #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Refreshes a remote by downloading new metadata. * Refreshes a remote by downloading new metadata.
* *
@ -1441,8 +1441,8 @@ fwupd_client_modify_remote_cb (GObject *source, GAsyncResult *res, gpointer user
* @remote_id: the remote ID, e.g. `lvfs-testing` * @remote_id: the remote ID, e.g. `lvfs-testing`
* @key: the key, e.g. `Enabled` * @key: the key, e.g. `Enabled`
* @value: the key, e.g. `true` * @value: the key, e.g. `true`
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Modifies a system remote in a specific way. * Modifies a system remote in a specific way.
* *
@ -1498,8 +1498,8 @@ fwupd_client_get_report_metadata_cb (GObject *source, GAsyncResult *res, gpointe
/** /**
* fwupd_client_get_report_metadata: * fwupd_client_get_report_metadata:
* @self: A #FwupdClient * @self: A #FwupdClient
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets all the report metadata from the daemon. * Gets all the report metadata from the daemon.
* *
@ -1549,8 +1549,8 @@ fwupd_client_modify_device_cb (GObject *source, GAsyncResult *res, gpointer user
* @device_id: the device ID * @device_id: the device ID
* @key: the key, e.g. `Flags` * @key: the key, e.g. `Flags`
* @value: the key, e.g. `reported` * @value: the key, e.g. `reported`
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Modifies a device in a specific way. Not all properties on the #FwupdDevice * Modifies a device in a specific way. Not all properties on the #FwupdDevice
* are settable by the client, and some may have other restrictions on @value. * are settable by the client, and some may have other restrictions on @value.
@ -1607,8 +1607,8 @@ fwupd_client_get_remotes_cb (GObject *source, GAsyncResult *res, gpointer user_d
/** /**
* fwupd_client_get_remotes: * fwupd_client_get_remotes:
* @self: A #FwupdClient * @self: A #FwupdClient
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the list of remotes that have been configured for the system. * Gets the list of remotes that have been configured for the system.
* *
@ -1656,8 +1656,8 @@ fwupd_client_get_remote_by_id_noref (GPtrArray *remotes, const gchar *remote_id)
* fwupd_client_get_remote_by_id: * fwupd_client_get_remote_by_id:
* @self: A #FwupdClient * @self: A #FwupdClient
* @remote_id: the remote ID, e.g. `lvfs-testing` * @remote_id: the remote ID, e.g. `lvfs-testing`
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets a specific remote that has been configured for the system. * Gets a specific remote that has been configured for the system.
* *
@ -1708,8 +1708,8 @@ fwupd_client_get_approved_firmware_cb (GObject *source, GAsyncResult *res, gpoin
/** /**
* fwupd_client_get_approved_firmware: * fwupd_client_get_approved_firmware:
* @self: A #FwupdClient * @self: A #FwupdClient
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the list of approved firmware. * Gets the list of approved firmware.
* *
@ -1763,8 +1763,8 @@ fwupd_client_set_approved_firmware_cb (GObject *source, GAsyncResult *res, gpoin
* fwupd_client_set_approved_firmware: * fwupd_client_set_approved_firmware:
* @self: A #FwupdClient * @self: A #FwupdClient
* @checksums: Array of checksums * @checksums: Array of checksums
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Sets the list of approved firmware. * Sets the list of approved firmware.
* *
@ -1813,8 +1813,8 @@ fwupd_client_get_blocked_firmware_cb (GObject *source, GAsyncResult *res, gpoint
/** /**
* fwupd_client_get_blocked_firmware: * fwupd_client_get_blocked_firmware:
* @self: A #FwupdClient * @self: A #FwupdClient
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the list of blocked firmware. * Gets the list of blocked firmware.
* *
@ -1868,8 +1868,8 @@ fwupd_client_set_blocked_firmware_cb (GObject *source, GAsyncResult *res, gpoint
* fwupd_client_set_blocked_firmware: * fwupd_client_set_blocked_firmware:
* @self: A #FwupdClient * @self: A #FwupdClient
* @checksums: Array of checksums * @checksums: Array of checksums
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Sets the list of approved firmware. * Sets the list of approved firmware.
* *
@ -1923,8 +1923,8 @@ fwupd_client_set_feature_flags_cb (GObject *source, GAsyncResult *res, gpointer
* fwupd_client_set_feature_flags: * fwupd_client_set_feature_flags:
* @self: A #FwupdClient * @self: A #FwupdClient
* @feature_flags: #FwupdFeatureFlags, e.g. %FWUPD_FEATURE_FLAG_UPDATE_TEXT * @feature_flags: #FwupdFeatureFlags, e.g. %FWUPD_FEATURE_FLAG_UPDATE_TEXT
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Sets the features the client supports. This allows firmware to depend on * Sets the features the client supports. This allows firmware to depend on
* specific front-end features, for instance showing the user an image on * specific front-end features, for instance showing the user an image on
@ -1978,8 +1978,8 @@ fwupd_client_self_sign_cb (GObject *source, GAsyncResult *res, gpointer user_dat
* @self: A #FwupdClient * @self: A #FwupdClient
* @value: A string to sign, typically a JSON blob * @value: A string to sign, typically a JSON blob
* @flags: #FwupdSelfSignFlags, e.g. %FWUPD_SELF_SIGN_FLAG_ADD_TIMESTAMP * @flags: #FwupdSelfSignFlags, e.g. %FWUPD_SELF_SIGN_FLAG_ADD_TIMESTAMP
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Signs the data using the client self-signed certificate. * Signs the data using the client self-signed certificate.
* *
@ -2031,8 +2031,8 @@ fwupd_client_download_bytes_cb (GObject *source, GAsyncResult *res, gpointer use
* @self: A #FwupdClient * @self: A #FwupdClient
* @url: the remote URL * @url: the remote URL
* @flags: #FwupdClientDownloadFlags, e.g. %FWUPD_CLIENT_DOWNLOAD_FLAG_NONE * @flags: #FwupdClientDownloadFlags, e.g. %FWUPD_CLIENT_DOWNLOAD_FLAG_NONE
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Downloads data from a remote server. The fwupd_client_set_user_agent() function * Downloads data from a remote server. The fwupd_client_set_user_agent() function
* should be called before this method is used. * should be called before this method is used.
@ -2078,8 +2078,8 @@ fwupd_client_download_bytes (FwupdClient *self,
* @url: the remote URL * @url: the remote URL
* @file: a #GFile * @file: a #GFile
* @flags: #FwupdClientDownloadFlags, e.g. %FWUPD_CLIENT_DOWNLOAD_FLAG_NONE * @flags: #FwupdClientDownloadFlags, e.g. %FWUPD_CLIENT_DOWNLOAD_FLAG_NONE
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Downloads data from a remote server. The fwupd_client_set_user_agent() function * Downloads data from a remote server. The fwupd_client_set_user_agent() function
* should be called before this method is used. * should be called before this method is used.
@ -2138,8 +2138,8 @@ fwupd_client_upload_bytes_cb (GObject *source, GAsyncResult *res, gpointer user_
* @payload: payload string * @payload: payload string
* @signature: (nullable): signature string * @signature: (nullable): signature string
* @flags: #FwupdClientDownloadFlags, e.g. %FWUPD_CLIENT_DOWNLOAD_FLAG_NONE * @flags: #FwupdClientDownloadFlags, e.g. %FWUPD_CLIENT_DOWNLOAD_FLAG_NONE
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Uploads data to a remote server. The fwupd_client_set_user_agent() function * Uploads data to a remote server. The fwupd_client_set_user_agent() function
* should be called before this method is used. * should be called before this method is used.

150
libfwupd/fwupd-client.c
View File

@ -437,7 +437,7 @@ fwupd_client_signal_cb (GDBusProxy *proxy,
* Gets the internal #GMainContext to use for synchronous methods. * Gets the internal #GMainContext to use for synchronous methods.
* By default the value is set a new #GMainContext. * By default the value is set a new #GMainContext.
* *
* Return value: (transfer full): the #GMainContext * Returns: (transfer full): the #GMainContext
* *
* Since: 1.5.3 * Since: 1.5.3
**/ **/
@ -473,7 +473,7 @@ fwupd_client_set_main_context (FwupdClient *self, GMainContext *main_ctx)
/** /**
* fwupd_client_ensure_networking: * fwupd_client_ensure_networking:
* @self: A #FwupdClient * @self: A #FwupdClient
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Sets up the client networking support ready for use. Most other download and * Sets up the client networking support ready for use. Most other download and
* upload methods call this automatically, and do you only need to call this if * upload methods call this automatically, and do you only need to call this if
@ -664,7 +664,7 @@ fwupd_client_connect_get_proxy_cb (GObject *source,
/** /**
* fwupd_client_connect_async: * fwupd_client_connect_async:
* @self: A #FwupdClient * @self: A #FwupdClient
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -710,7 +710,7 @@ fwupd_client_connect_async (FwupdClient *self, GCancellable *cancellable,
* fwupd_client_connect_finish: * fwupd_client_connect_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_connect_async(). * Gets the result of fwupd_client_connect_async().
* *
@ -785,7 +785,7 @@ fwupd_client_get_host_security_attrs_cb (GObject *source,
/** /**
* fwupd_client_get_host_security_attrs_async: * fwupd_client_get_host_security_attrs_async:
* @self: A #FwupdClient * @self: A #FwupdClient
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -823,7 +823,7 @@ fwupd_client_get_host_security_attrs_async (FwupdClient *self,
* fwupd_client_get_host_security_attrs_finish: * fwupd_client_get_host_security_attrs_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_get_host_security_attrs_async(). * Gets the result of fwupd_client_get_host_security_attrs_async().
* *
@ -886,7 +886,7 @@ fwupd_client_get_report_metadata_cb (GObject *source,
/** /**
* fwupd_client_get_report_metadata_async: * fwupd_client_get_report_metadata_async:
* @self: A #FwupdClient * @self: A #FwupdClient
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -924,7 +924,7 @@ fwupd_client_get_report_metadata_async (FwupdClient *self,
* fwupd_client_get_report_metadata_finish: * fwupd_client_get_report_metadata_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_get_report_metadata_async(). * Gets the result of fwupd_client_get_report_metadata_async().
* *
@ -966,7 +966,7 @@ fwupd_client_get_devices_cb (GObject *source,
/** /**
* fwupd_client_get_devices_async: * fwupd_client_get_devices_async:
* @self: A #FwupdClient * @self: A #FwupdClient
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -1001,7 +1001,7 @@ fwupd_client_get_devices_async (FwupdClient *self, GCancellable *cancellable,
* fwupd_client_get_devices_finish: * fwupd_client_get_devices_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_get_devices_async(). * Gets the result of fwupd_client_get_devices_async().
* *
@ -1043,7 +1043,7 @@ fwupd_client_get_plugins_cb (GObject *source,
/** /**
* fwupd_client_get_plugins_async: * fwupd_client_get_plugins_async:
* @self: A #FwupdClient * @self: A #FwupdClient
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -1078,7 +1078,7 @@ fwupd_client_get_plugins_async (FwupdClient *self, GCancellable *cancellable,
* fwupd_client_get_plugins_finish: * fwupd_client_get_plugins_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_get_plugins_async(). * Gets the result of fwupd_client_get_plugins_async().
* *
@ -1120,7 +1120,7 @@ fwupd_client_get_history_cb (GObject *source,
/** /**
* fwupd_client_get_history_async: * fwupd_client_get_history_async:
* @self: A #FwupdClient * @self: A #FwupdClient
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -1155,7 +1155,7 @@ fwupd_client_get_history_async (FwupdClient *self, GCancellable *cancellable,
* fwupd_client_get_history_finish: * fwupd_client_get_history_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_get_history_async(). * Gets the result of fwupd_client_get_history_async().
* *
@ -1210,7 +1210,7 @@ fwupd_client_get_device_by_id_cb (GObject *source,
* fwupd_client_get_device_by_id_async: * fwupd_client_get_device_by_id_async:
* @self: A #FwupdClient * @self: A #FwupdClient
* @device_id: the device ID * @device_id: the device ID
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -1247,7 +1247,7 @@ fwupd_client_get_device_by_id_async (FwupdClient *self, const gchar *device_id,
* fwupd_client_get_device_by_id_finish: * fwupd_client_get_device_by_id_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_get_device_by_id_async(). * Gets the result of fwupd_client_get_device_by_id_async().
* *
@ -1309,7 +1309,7 @@ fwupd_client_get_devices_by_guid_cb (GObject *source,
* fwupd_client_get_devices_by_guid_async: * fwupd_client_get_devices_by_guid_async:
* @self: A #FwupdClient * @self: A #FwupdClient
* @guid: the GUID, e.g. `e22c4520-43dc-5bb3-8245-5787fead9b63` * @guid: the GUID, e.g. `e22c4520-43dc-5bb3-8245-5787fead9b63`
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -1347,7 +1347,7 @@ fwupd_client_get_devices_by_guid_async (FwupdClient *self, const gchar *guid,
* fwupd_client_get_devices_by_guid_finish: * fwupd_client_get_devices_by_guid_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_get_devices_by_guid_async(). * Gets the result of fwupd_client_get_devices_by_guid_async().
* *
@ -1390,7 +1390,7 @@ fwupd_client_get_releases_cb (GObject *source,
* fwupd_client_get_releases_async: * fwupd_client_get_releases_async:
* @self: A #FwupdClient * @self: A #FwupdClient
* @device_id: the device ID * @device_id: the device ID
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -1429,7 +1429,7 @@ fwupd_client_get_releases_async (FwupdClient *self, const gchar *device_id,
* fwupd_client_get_releases_finish: * fwupd_client_get_releases_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_get_releases_async(). * Gets the result of fwupd_client_get_releases_async().
* *
@ -1472,7 +1472,7 @@ fwupd_client_get_downgrades_cb (GObject *source,
* fwupd_client_get_downgrades_async: * fwupd_client_get_downgrades_async:
* @self: A #FwupdClient * @self: A #FwupdClient
* @device_id: the device ID * @device_id: the device ID
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -1511,7 +1511,7 @@ fwupd_client_get_downgrades_async (FwupdClient *self, const gchar *device_id,
* fwupd_client_get_downgrades_finish: * fwupd_client_get_downgrades_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_get_downgrades_async(). * Gets the result of fwupd_client_get_downgrades_async().
* *
@ -1554,7 +1554,7 @@ fwupd_client_get_upgrades_cb (GObject *source,
* fwupd_client_get_upgrades_async: * fwupd_client_get_upgrades_async:
* @self: A #FwupdClient * @self: A #FwupdClient
* @device_id: the device ID * @device_id: the device ID
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -1593,7 +1593,7 @@ fwupd_client_get_upgrades_async (FwupdClient *self, const gchar *device_id,
* fwupd_client_get_upgrades_finish: * fwupd_client_get_upgrades_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_get_upgrades_async(). * Gets the result of fwupd_client_get_upgrades_async().
* *
@ -1635,7 +1635,7 @@ fwupd_client_modify_config_cb (GObject *source,
* @self: A #FwupdClient * @self: A #FwupdClient
* @key: key, e.g. `DisabledPlugins` * @key: key, e.g. `DisabledPlugins`
* @value: value, e.g. `*` * @value: value, e.g. `*`
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -1675,7 +1675,7 @@ fwupd_client_modify_config_async (FwupdClient *self,
* fwupd_client_modify_config_finish: * fwupd_client_modify_config_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_modify_config_async(). * Gets the result of fwupd_client_modify_config_async().
* *
@ -1716,7 +1716,7 @@ fwupd_client_activate_cb (GObject *source,
* fwupd_client_activate_async: * fwupd_client_activate_async:
* @self: A #FwupdClient * @self: A #FwupdClient
* @device_id: a device * @device_id: a device
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -1754,7 +1754,7 @@ fwupd_client_activate_async (FwupdClient *self,
* fwupd_client_activate_finish: * fwupd_client_activate_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_activate_async(). * Gets the result of fwupd_client_activate_async().
* *
@ -1795,7 +1795,7 @@ fwupd_client_verify_cb (GObject *source,
* fwupd_client_verify_async: * fwupd_client_verify_async:
* @self: A #FwupdClient * @self: A #FwupdClient
* @device_id: the device ID * @device_id: the device ID
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -1832,7 +1832,7 @@ fwupd_client_verify_async (FwupdClient *self,
* fwupd_client_verify_finish: * fwupd_client_verify_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_verify_async(). * Gets the result of fwupd_client_verify_async().
* *
@ -1873,7 +1873,7 @@ fwupd_client_verify_update_cb (GObject *source,
* fwupd_client_verify_update_async: * fwupd_client_verify_update_async:
* @self: A #FwupdClient * @self: A #FwupdClient
* @device_id: the device ID * @device_id: the device ID
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -1910,7 +1910,7 @@ fwupd_client_verify_update_async (FwupdClient *self,
* fwupd_client_verify_update_finish: * fwupd_client_verify_update_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_verify_update_async(). * Gets the result of fwupd_client_verify_update_async().
* *
@ -1951,7 +1951,7 @@ fwupd_client_unlock_cb (GObject *source,
* fwupd_client_unlock_async: * fwupd_client_unlock_async:
* @self: A #FwupdClient * @self: A #FwupdClient
* @device_id: the device ID * @device_id: the device ID
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -1988,7 +1988,7 @@ fwupd_client_unlock_async (FwupdClient *self,
* fwupd_client_unlock_finish: * fwupd_client_unlock_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_unlock_async(). * Gets the result of fwupd_client_unlock_async().
* *
@ -2029,7 +2029,7 @@ fwupd_client_clear_results_cb (GObject *source,
* fwupd_client_clear_results_async: * fwupd_client_clear_results_async:
* @self: A #FwupdClient * @self: A #FwupdClient
* @device_id: a device * @device_id: a device
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -2066,7 +2066,7 @@ fwupd_client_clear_results_async (FwupdClient *self,
* fwupd_client_clear_results_finish: * fwupd_client_clear_results_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_clear_results_async(). * Gets the result of fwupd_client_clear_results_async().
* *
@ -2109,7 +2109,7 @@ fwupd_client_get_results_cb (GObject *source,
* fwupd_client_get_results_async: * fwupd_client_get_results_async:
* @self: A #FwupdClient * @self: A #FwupdClient
* @device_id: the device ID * @device_id: the device ID
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -2148,7 +2148,7 @@ fwupd_client_get_results_async (FwupdClient *self, const gchar *device_id,
* fwupd_client_get_results_finish: * fwupd_client_get_results_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_get_results_async(). * Gets the result of fwupd_client_get_results_async().
* *
@ -2275,7 +2275,7 @@ fwupd_client_install_stream_async (FwupdClient *self,
* @device_id: the device ID * @device_id: the device ID
* @bytes: #GBytes * @bytes: #GBytes
* @install_flags: the #FwupdInstallFlags, e.g. %FWUPD_INSTALL_FLAG_ALLOW_REINSTALL * @install_flags: the #FwupdInstallFlags, e.g. %FWUPD_INSTALL_FLAG_ALLOW_REINSTALL
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -2330,7 +2330,7 @@ fwupd_client_install_bytes_async (FwupdClient *self,
* fwupd_client_install_bytes_finish: * fwupd_client_install_bytes_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_install_bytes_async(). * Gets the result of fwupd_client_install_bytes_async().
* *
@ -2353,7 +2353,7 @@ fwupd_client_install_bytes_finish (FwupdClient *self, GAsyncResult *res, GError
* @device_id: the device ID * @device_id: the device ID
* @filename: the filename to install * @filename: the filename to install
* @install_flags: the #FwupdInstallFlags, e.g. %FWUPD_INSTALL_FLAG_ALLOW_REINSTALL * @install_flags: the #FwupdInstallFlags, e.g. %FWUPD_INSTALL_FLAG_ALLOW_REINSTALL
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -2410,7 +2410,7 @@ fwupd_client_install_async (FwupdClient *self,
* fwupd_client_install_finish: * fwupd_client_install_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_install_async(). * Gets the result of fwupd_client_install_async().
* *
@ -2647,7 +2647,7 @@ fwupd_client_filter_locations (GPtrArray *locations,
* @release: A #FwupdRelease * @release: A #FwupdRelease
* @install_flags: the #FwupdInstallFlags, e.g. %FWUPD_INSTALL_FLAG_ALLOW_REINSTALL * @install_flags: the #FwupdInstallFlags, e.g. %FWUPD_INSTALL_FLAG_ALLOW_REINSTALL
* @download_flags: the #FwupdClientDownloadFlags, e.g. %FWUPD_CLIENT_DOWNLOAD_FLAG_DISABLE_IPFS * @download_flags: the #FwupdClientDownloadFlags, e.g. %FWUPD_CLIENT_DOWNLOAD_FLAG_DISABLE_IPFS
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -2713,7 +2713,7 @@ fwupd_client_install_release2_async (FwupdClient *self,
* @device: A #FwupdDevice * @device: A #FwupdDevice
* @release: A #FwupdRelease * @release: A #FwupdRelease
* @install_flags: the #FwupdInstallFlags, e.g. %FWUPD_INSTALL_FLAG_ALLOW_REINSTALL * @install_flags: the #FwupdInstallFlags, e.g. %FWUPD_INSTALL_FLAG_ALLOW_REINSTALL
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -2744,7 +2744,7 @@ fwupd_client_install_release_async (FwupdClient *self,
* fwupd_client_install_release_finish: * fwupd_client_install_release_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_install_release_async(). * Gets the result of fwupd_client_install_release_async().
* *
@ -2828,7 +2828,7 @@ fwupd_client_get_details_stream_async (FwupdClient *self,
* fwupd_client_get_details_bytes_async: * fwupd_client_get_details_bytes_async:
* @self: A #FwupdClient * @self: A #FwupdClient
* @bytes: a #GBytes for the firmware, e.g. `firmware.cab` * @bytes: a #GBytes for the firmware, e.g. `firmware.cab`
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -2876,7 +2876,7 @@ fwupd_client_get_details_bytes_async (FwupdClient *self,
* fwupd_client_get_details_bytes_finish: * fwupd_client_get_details_bytes_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_get_details_bytes_async(). * Gets the result of fwupd_client_get_details_bytes_async().
* *
@ -3109,7 +3109,7 @@ fwupd_client_update_metadata_stream_async (FwupdClient *self,
* @remote_id: remote ID, e.g. `lvfs-testing` * @remote_id: remote ID, e.g. `lvfs-testing`
* @metadata: XML metadata data * @metadata: XML metadata data
* @signature: signature data * @signature: signature data
* @cancellable: #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -3179,7 +3179,7 @@ fwupd_client_update_metadata_bytes_async (FwupdClient *self,
* fwupd_client_update_metadata_bytes_finish: * fwupd_client_update_metadata_bytes_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_update_metadata_bytes_async(). * Gets the result of fwupd_client_update_metadata_bytes_async().
* *
@ -3315,7 +3315,7 @@ fwupd_client_refresh_remote_signature_cb (GObject *source,
* fwupd_client_refresh_remote_async: * fwupd_client_refresh_remote_async:
* @self: A #FwupdClient * @self: A #FwupdClient
* @remote: A #FwupdRemote * @remote: A #FwupdRemote
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -3362,7 +3362,7 @@ fwupd_client_refresh_remote_async (FwupdClient *self,
* fwupd_client_refresh_remote_finish: * fwupd_client_refresh_remote_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_refresh_remote_async(). * Gets the result of fwupd_client_refresh_remote_async().
* *
@ -3404,7 +3404,7 @@ fwupd_client_get_remotes_cb (GObject *source,
/** /**
* fwupd_client_get_remotes_async: * fwupd_client_get_remotes_async:
* @self: A #FwupdClient * @self: A #FwupdClient
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -3439,7 +3439,7 @@ fwupd_client_get_remotes_async (FwupdClient *self, GCancellable *cancellable,
* fwupd_client_get_remotes_finish: * fwupd_client_get_remotes_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_get_remotes_async(). * Gets the result of fwupd_client_get_remotes_async().
* *
@ -3487,7 +3487,7 @@ fwupd_client_get_approved_firmware_cb (GObject *source,
/** /**
* fwupd_client_get_approved_firmware_async: * fwupd_client_get_approved_firmware_async:
* @self: A #FwupdClient * @self: A #FwupdClient
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -3525,7 +3525,7 @@ fwupd_client_get_approved_firmware_async (FwupdClient *self,
* fwupd_client_get_approved_firmware_finish: * fwupd_client_get_approved_firmware_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_get_approved_firmware_async(). * Gets the result of fwupd_client_get_approved_firmware_async().
* *
@ -3566,7 +3566,7 @@ fwupd_client_set_approved_firmware_cb (GObject *source,
* fwupd_client_set_approved_firmware_async: * fwupd_client_set_approved_firmware_async:
* @self: A #FwupdClient * @self: A #FwupdClient
* @checksums: (element-type utf8): firmware checksums * @checksums: (element-type utf8): firmware checksums
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -3608,7 +3608,7 @@ fwupd_client_set_approved_firmware_async (FwupdClient *self,
* fwupd_client_set_approved_firmware_finish: * fwupd_client_set_approved_firmware_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_set_approved_firmware_async(). * Gets the result of fwupd_client_set_approved_firmware_async().
* *
@ -3656,7 +3656,7 @@ fwupd_client_get_blocked_firmware_cb (GObject *source,
/** /**
* fwupd_client_get_blocked_firmware_async: * fwupd_client_get_blocked_firmware_async:
* @self: A #FwupdClient * @self: A #FwupdClient
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -3694,7 +3694,7 @@ fwupd_client_get_blocked_firmware_async (FwupdClient *self,
* fwupd_client_get_blocked_firmware_finish: * fwupd_client_get_blocked_firmware_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_get_blocked_firmware_async(). * Gets the result of fwupd_client_get_blocked_firmware_async().
* *
@ -3735,7 +3735,7 @@ fwupd_client_set_blocked_firmware_cb (GObject *source,
* fwupd_client_set_blocked_firmware_async: * fwupd_client_set_blocked_firmware_async:
* @self: A #FwupdClient * @self: A #FwupdClient
* @checksums: (element-type utf8): firmware checksums * @checksums: (element-type utf8): firmware checksums
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -3777,7 +3777,7 @@ fwupd_client_set_blocked_firmware_async (FwupdClient *self,
* fwupd_client_set_blocked_firmware_finish: * fwupd_client_set_blocked_firmware_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_set_blocked_firmware_async(). * Gets the result of fwupd_client_set_blocked_firmware_async().
* *
@ -3818,7 +3818,7 @@ fwupd_client_set_feature_flags_cb (GObject *source,
* fwupd_client_set_feature_flags_async: * fwupd_client_set_feature_flags_async:
* @self: A #FwupdClient * @self: A #FwupdClient
* @feature_flags: #FwupdFeatureFlags, e.g. %FWUPD_FEATURE_FLAG_UPDATE_TEXT * @feature_flags: #FwupdFeatureFlags, e.g. %FWUPD_FEATURE_FLAG_UPDATE_TEXT
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -3856,7 +3856,7 @@ fwupd_client_set_feature_flags_async (FwupdClient *self,
* fwupd_client_set_feature_flags_finish: * fwupd_client_set_feature_flags_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_set_feature_flags_async(). * Gets the result of fwupd_client_set_feature_flags_async().
* *
@ -3900,7 +3900,7 @@ fwupd_client_self_sign_cb (GObject *source, GAsyncResult *res, gpointer user_dat
* @self: A #FwupdClient * @self: A #FwupdClient
* @value: A string to sign, typically a JSON blob * @value: A string to sign, typically a JSON blob
* @flags: #FwupdSelfSignFlags, e.g. %FWUPD_SELF_SIGN_FLAG_ADD_TIMESTAMP * @flags: #FwupdSelfSignFlags, e.g. %FWUPD_SELF_SIGN_FLAG_ADD_TIMESTAMP
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -3954,7 +3954,7 @@ fwupd_client_self_sign_async (FwupdClient *self,
* fwupd_client_self_sign_finish: * fwupd_client_self_sign_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_self_sign_async(). * Gets the result of fwupd_client_self_sign_async().
* *
@ -3997,7 +3997,7 @@ fwupd_client_modify_remote_cb (GObject *source,
* @remote_id: the remote ID, e.g. `lvfs-testing` * @remote_id: the remote ID, e.g. `lvfs-testing`
* @key: the key, e.g. `Enabled` * @key: the key, e.g. `Enabled`
* @value: the key, e.g. `true` * @value: the key, e.g. `true`
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -4038,7 +4038,7 @@ fwupd_client_modify_remote_async (FwupdClient *self,
* fwupd_client_modify_remote_finish: * fwupd_client_modify_remote_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_modify_remote_async(). * Gets the result of fwupd_client_modify_remote_async().
* *
@ -4081,7 +4081,7 @@ fwupd_client_modify_device_cb (GObject *source,
* @device_id: the device ID * @device_id: the device ID
* @key: the key, e.g. `Flags` * @key: the key, e.g. `Flags`
* @value: the key, e.g. `reported` * @value: the key, e.g. `reported`
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -4123,7 +4123,7 @@ fwupd_client_modify_device_async (FwupdClient *self,
* fwupd_client_modify_device_finish: * fwupd_client_modify_device_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_modify_device_async(). * Gets the result of fwupd_client_modify_device_async().
* *
@ -4188,7 +4188,7 @@ fwupd_client_get_remote_by_id_cb (GObject *source,
* fwupd_client_get_remote_by_id_async: * fwupd_client_get_remote_by_id_async:
* @self: A #FwupdClient * @self: A #FwupdClient
* @remote_id: the remote ID, e.g. `lvfs-testing` * @remote_id: the remote ID, e.g. `lvfs-testing`
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -4223,7 +4223,7 @@ fwupd_client_get_remote_by_id_async (FwupdClient *self,
* fwupd_client_get_remote_by_id_finish: * fwupd_client_get_remote_by_id_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_get_remote_by_id_async(). * Gets the result of fwupd_client_get_remote_by_id_async().
* *
@ -4537,7 +4537,7 @@ fwupd_client_download_bytes2_async (FwupdClient *self,
* @self: A #FwupdClient * @self: A #FwupdClient
* @url: the remote URL * @url: the remote URL
* @flags: #FwupdClientDownloadFlags, e.g. %FWUPD_CLIENT_DOWNLOAD_FLAG_NONE * @flags: #FwupdClientDownloadFlags, e.g. %FWUPD_CLIENT_DOWNLOAD_FLAG_NONE
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -4579,7 +4579,7 @@ fwupd_client_download_bytes_async (FwupdClient *self,
* fwupd_client_download_bytes_finish: * fwupd_client_download_bytes_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_download_bytes_async(). * Gets the result of fwupd_client_download_bytes_async().
* *
@ -4647,7 +4647,7 @@ fwupd_client_upload_bytes_thread_cb (GTask *task,
* @payload: payload string * @payload: payload string
* @signature: (nullable): signature string * @signature: (nullable): signature string
* @flags: #FwupdClientDownloadFlags, e.g. %FWUPD_CLIENT_DOWNLOAD_FLAG_NONE * @flags: #FwupdClientDownloadFlags, e.g. %FWUPD_CLIENT_DOWNLOAD_FLAG_NONE
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @callback: the function to run on completion * @callback: the function to run on completion
* @callback_data: the data to pass to @callback * @callback_data: the data to pass to @callback
* *
@ -4733,7 +4733,7 @@ fwupd_client_upload_bytes_async (FwupdClient *self,
* fwupd_client_upload_bytes_finish: * fwupd_client_upload_bytes_finish:
* @self: A #FwupdClient * @self: A #FwupdClient
* @res: the #GAsyncResult * @res: the #GAsyncResult
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the result of fwupd_client_upload_bytes_async(). * Gets the result of fwupd_client_upload_bytes_async().
* *

10
libfwupd/fwupd-common.c
View File

@ -141,7 +141,7 @@ fwupd_checksum_get_best (GPtrArray *checksums)
/** /**
* fwupd_get_os_release: * fwupd_get_os_release:
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Loads information from the system os-release file. * Loads information from the system os-release file.
* *
@ -338,8 +338,8 @@ fwupd_build_user_agent (const gchar *package_name, const gchar *package_version)
/** /**
* fwupd_build_machine_id: * fwupd_build_machine_id:
* @salt: The salt, or %NULL for none * @salt: (nullable): optional salt
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Gets a salted hash of the /etc/machine-id contents. This can be used to * Gets a salted hash of the /etc/machine-id contents. This can be used to
* identify a specific machine. It is not possible to recover the original * identify a specific machine. It is not possible to recover the original
@ -524,7 +524,7 @@ fwupd_build_history_report_json_metadata (JsonBuilder *builder, GError **error)
/** /**
* fwupd_build_history_report_json: * fwupd_build_history_report_json:
* @devices: (element-type FwupdDevice): devices * @devices: (element-type FwupdDevice): devices
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Builds a JSON report for the list of devices. No filtering is done on the * Builds a JSON report for the list of devices. No filtering is done on the
* @devices array, and it is expected that the caller will filter to something * @devices array, and it is expected that the caller will filter to something
@ -718,7 +718,7 @@ g_ascii_string_to_unsigned (const gchar *str,
* @guidstr: (nullable): a GUID, e.g. `00112233-4455-6677-8899-aabbccddeeff` * @guidstr: (nullable): a GUID, e.g. `00112233-4455-6677-8899-aabbccddeeff`
* @guid: a #fwupd_guid_t, or NULL to just check the GUID * @guid: a #fwupd_guid_t, or NULL to just check the GUID
* @flags: some %FwupdGuidFlags, e.g. %FWUPD_GUID_FLAG_MIXED_ENDIAN * @flags: some %FwupdGuidFlags, e.g. %FWUPD_GUID_FLAG_MIXED_ENDIAN
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Converts a string GUID into its binary encoding. All string GUIDs are * Converts a string GUID into its binary encoding. All string GUIDs are
* formatted as big endian but on-disk can be encoded in different ways. * formatted as big endian but on-disk can be encoded in different ways.

2
libfwupd/fwupd-device.c
View File

@ -415,7 +415,7 @@ fwupd_device_get_parent (FwupdDevice *device)
/** /**
* fwupd_device_set_parent: * fwupd_device_set_parent:
* @device: A #FwupdDevice * @device: A #FwupdDevice
* @parent: another #FwupdDevice, or %NULL * @parent: (nullable): another #FwupdDevice
* *
* Sets the parent. Only used internally. * Sets the parent. Only used internally.
* *

32
libfwupd/fwupd-enums.c
View File

@ -24,7 +24,7 @@
* *
* Converts a #FwupdStatus to a string. * Converts a #FwupdStatus to a string.
* *
* Return value: identifier string * Returns: identifier string
* *
* Since: 0.1.1 * Since: 0.1.1
**/ **/
@ -68,7 +68,7 @@ fwupd_status_to_string (FwupdStatus status)
* *
* Converts a string to a #FwupdStatus. * Converts a string to a #FwupdStatus.
* *
* Return value: enumerated value * Returns: enumerated value
* *
* Since: 0.1.1 * Since: 0.1.1
**/ **/
@ -112,7 +112,7 @@ fwupd_status_from_string (const gchar *status)
* *
* Converts a #FwupdDeviceFlags to a string. * Converts a #FwupdDeviceFlags to a string.
* *
* Return value: identifier string * Returns: identifier string
* *
* Since: 0.7.0 * Since: 0.7.0
**/ **/
@ -214,7 +214,7 @@ fwupd_device_flag_to_string (FwupdDeviceFlags device_flag)
* *
* Converts a string to a #FwupdDeviceFlags. * Converts a string to a #FwupdDeviceFlags.
* *
* Return value: enumerated value * Returns: enumerated value
* *
* Since: 0.7.0 * Since: 0.7.0
**/ **/
@ -316,7 +316,7 @@ fwupd_device_flag_from_string (const gchar *device_flag)
* *
* Converts a #FwupdDeviceFlags to a string. * Converts a #FwupdDeviceFlags to a string.
* *
* Return value: identifier string * Returns: identifier string
* *
* Since: 1.5.0 * Since: 1.5.0
**/ **/
@ -358,7 +358,7 @@ fwupd_plugin_flag_to_string (FwupdPluginFlags plugin_flag)
* *
* Converts a string to a #FwupdPluginFlags. * Converts a string to a #FwupdPluginFlags.
* *
* Return value: enumerated value * Returns: enumerated value
* *
* Since: 1.5.0 * Since: 1.5.0
**/ **/
@ -398,7 +398,7 @@ fwupd_plugin_flag_from_string (const gchar *plugin_flag)
* *
* Converts a #FwupdUpdateState to a string. * Converts a #FwupdUpdateState to a string.
* *
* Return value: identifier string * Returns: identifier string
* *
* Since: 0.7.0 * Since: 0.7.0
**/ **/
@ -426,7 +426,7 @@ fwupd_update_state_to_string (FwupdUpdateState update_state)
* *
* Converts a string to a #FwupdUpdateState. * Converts a string to a #FwupdUpdateState.
* *
* Return value: enumerated value * Returns: enumerated value
* *
* Since: 0.7.0 * Since: 0.7.0
**/ **/
@ -454,7 +454,7 @@ fwupd_update_state_from_string (const gchar *update_state)
* *
* Converts a #FwupdTrustFlags to a string. * Converts a #FwupdTrustFlags to a string.
* *
* Return value: identifier string * Returns: identifier string
* *
* Since: 0.7.0 * Since: 0.7.0
**/ **/
@ -476,7 +476,7 @@ fwupd_trust_flag_to_string (FwupdTrustFlags trust_flag)
* *
* Converts a string to a #FwupdTrustFlags. * Converts a string to a #FwupdTrustFlags.
* *
* Return value: enumerated value * Returns: enumerated value
* *
* Since: 0.7.0 * Since: 0.7.0
**/ **/
@ -498,7 +498,7 @@ fwupd_trust_flag_from_string (const gchar *trust_flag)
* *
* Converts a #FwupdFeatureFlags to a string. * Converts a #FwupdFeatureFlags to a string.
* *
* Return value: identifier string * Returns: identifier string
* *
* Since: 1.4.5 * Since: 1.4.5
**/ **/
@ -524,7 +524,7 @@ fwupd_feature_flag_to_string (FwupdFeatureFlags feature_flag)
* *
* Converts a string to a #FwupdFeatureFlags. * Converts a string to a #FwupdFeatureFlags.
* *
* Return value: enumerated value * Returns: enumerated value
* *
* Since: 1.4.5 * Since: 1.4.5
**/ **/
@ -598,7 +598,7 @@ fwupd_keyring_kind_to_string (FwupdKeyringKind keyring_kind)
* *
* Converts a #FwupdReleaseFlags to a string. * Converts a #FwupdReleaseFlags to a string.
* *
* Return value: identifier string * Returns: identifier string
* *
* Since: 1.2.6 * Since: 1.2.6
**/ **/
@ -630,7 +630,7 @@ fwupd_release_flag_to_string (FwupdReleaseFlags release_flag)
* *
* Converts a string to a #FwupdReleaseFlags. * Converts a string to a #FwupdReleaseFlags.
* *
* Return value: enumerated value * Returns: enumerated value
* *
* Since: 1.2.6 * Since: 1.2.6
**/ **/
@ -660,7 +660,7 @@ fwupd_release_flag_from_string (const gchar *release_flag)
* *
* Converts an enumerated value to a string. * Converts an enumerated value to a string.
* *
* Return value: identifier string * Returns: identifier string
* *
* Since: 1.4.0 * Since: 1.4.0
**/ **/
@ -684,7 +684,7 @@ fwupd_release_urgency_to_string (FwupdReleaseUrgency release_urgency)
* *
* Converts a string to an enumerated value. * Converts a string to an enumerated value.
* *
* Return value: enumerated value * Returns: enumerated value
* *
* Since: 1.4.0 * Since: 1.4.0
**/ **/

6
libfwupd/fwupd-error.c
View File

@ -28,7 +28,7 @@
* *
* Converts a #FwupdError to a string. * Converts a #FwupdError to a string.
* *
* Return value: identifier string * Returns: identifier string
* *
* Since: 0.7.0 * Since: 0.7.0
**/ **/
@ -78,7 +78,7 @@ fwupd_error_to_string (FwupdError error)
* *
* Converts a string to a #FwupdError. * Converts a string to a #FwupdError.
* *
* Return value: enumerated value * Returns: enumerated value
* *
* Since: 0.7.0 * Since: 0.7.0
**/ **/
@ -125,7 +125,7 @@ fwupd_error_from_string (const gchar *error)
/** /**
* fwupd_error_quark: * fwupd_error_quark:
* *
* Return value: An error quark. * Returns: An error quark.
* *
* Since: 0.1.1 * Since: 0.1.1
**/ **/

10
libfwupd/fwupd-remote.c
View File

@ -391,8 +391,8 @@ fwupd_remote_set_filename_cache (FwupdRemote *self, const gchar *filename)
* fwupd_remote_load_from_filename: * fwupd_remote_load_from_filename:
* @self: A #FwupdRemote * @self: A #FwupdRemote
* @filename: A filename * @filename: A filename
* @cancellable: the #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Sets up the remote ready for use. Most other methods call this * Sets up the remote ready for use. Most other methods call this
* for you, and do you only need to call this if you are just watching * for you, and do you only need to call this if you are just watching
@ -926,7 +926,7 @@ fwupd_remote_get_checksum (FwupdRemote *self)
* fwupd_remote_build_firmware_uri: * fwupd_remote_build_firmware_uri:
* @self: A #FwupdRemote * @self: A #FwupdRemote
* @url: the URL to use * @url: the URL to use
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Builds a URI for the URL using the username and password set for the remote, * Builds a URI for the URL using the username and password set for the remote,
* including any basename URI substitution. * including any basename URI substitution.
@ -1045,7 +1045,7 @@ fwupd_remote_load_signature_jcat (FwupdRemote *self, JcatFile *jcat_file, GError
* fwupd_remote_load_signature_bytes: * fwupd_remote_load_signature_bytes:
* @self: A #FwupdRemote * @self: A #FwupdRemote
* @bytes: A #GBytes * @bytes: A #GBytes
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Parses the signature, updating the metadata URI as appropriate. * Parses the signature, updating the metadata URI as appropriate.
* *
@ -1086,7 +1086,7 @@ fwupd_remote_load_signature_bytes (FwupdRemote *self, GBytes *bytes, GError **er
* fwupd_remote_load_signature: * fwupd_remote_load_signature:
* @self: A #FwupdRemote * @self: A #FwupdRemote
* @filename: A filename * @filename: A filename
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Parses the signature, updating the metadata URI as appropriate. * Parses the signature, updating the metadata URI as appropriate.
* *

6
libfwupdplugin/fu-archive.c
View File

@ -58,7 +58,7 @@ fu_archive_init (FuArchive *self)
* fu_archive_lookup_by_fn: * fu_archive_lookup_by_fn:
* @self: A #FuArchive * @self: A #FuArchive
* @fn: A filename * @fn: A filename
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Finds the blob referenced by filename * Finds the blob referenced by filename
* *
@ -90,7 +90,7 @@ fu_archive_lookup_by_fn (FuArchive *self, const gchar *fn, GError **error)
* @self: A #FuArchive * @self: A #FuArchive
* @callback: (scope call): A #FuArchiveIterateFunc. * @callback: (scope call): A #FuArchiveIterateFunc.
* @user_data: User data. * @user_data: User data.
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Iterates over the archive contents, calling the given function for each * Iterates over the archive contents, calling the given function for each
* of the files found. If any @callback returns %FALSE scanning is aborted. * of the files found. If any @callback returns %FALSE scanning is aborted.
@ -239,7 +239,7 @@ fu_archive_load (FuArchive *self, GBytes *blob, FuArchiveFlags flags, GError **e
* fu_archive_new: * fu_archive_new:
* @data: A #GBytes * @data: A #GBytes
* @flags: A #FuArchiveFlags, e.g. %FU_ARCHIVE_FLAG_NONE * @flags: A #FuArchiveFlags, e.g. %FU_ARCHIVE_FLAG_NONE
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Parses @data as an archive and decompresses all files to memory blobs. * Parses @data as an archive and decompresses all files to memory blobs.
* *

10
libfwupdplugin/fu-bluez-device.c
View File

@ -372,7 +372,7 @@ fu_bluez_device_probe (FuDevice *device, GError **error)
* fu_bluez_device_read: * fu_bluez_device_read:
* @self: A #FuBluezDevice * @self: A #FuBluezDevice
* @uuid: The UUID, e.g. `00cde35c-7062-11eb-9439-0242ac130002` * @uuid: The UUID, e.g. `00cde35c-7062-11eb-9439-0242ac130002`
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Reads from a UUID on the device. * Reads from a UUID on the device.
* *
@ -429,7 +429,7 @@ fu_bluez_device_read (FuBluezDevice *self, const gchar *uuid, GError **error)
* fu_bluez_device_read_string: * fu_bluez_device_read_string:
* @self: A #FuBluezDevice * @self: A #FuBluezDevice
* @uuid: The UUID, e.g. `00cde35c-7062-11eb-9439-0242ac130002` * @uuid: The UUID, e.g. `00cde35c-7062-11eb-9439-0242ac130002`
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Reads a string from a UUID on the device. * Reads a string from a UUID on the device.
* *
@ -451,7 +451,7 @@ fu_bluez_device_read_string (FuBluezDevice *self, const gchar *uuid, GError **er
* @self: A #FuBluezDevice * @self: A #FuBluezDevice
* @uuid: The UUID, e.g. `00cde35c-7062-11eb-9439-0242ac130002` * @uuid: The UUID, e.g. `00cde35c-7062-11eb-9439-0242ac130002`
* @buf: a #GByteArray * @buf: a #GByteArray
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Writes to a UUID on the device. * Writes to a UUID on the device.
* *
@ -510,7 +510,7 @@ fu_bluez_device_write (FuBluezDevice *self,
* fu_bluez_device_notify_start: * fu_bluez_device_notify_start:
* @self: A #FuBluezDevice * @self: A #FuBluezDevice
* @uuid: The UUID, e.g. `00cde35c-7062-11eb-9439-0242ac130002` * @uuid: The UUID, e.g. `00cde35c-7062-11eb-9439-0242ac130002`
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Enables notifications for property changes in a UUID (StartNotify * Enables notifications for property changes in a UUID (StartNotify
* method). * method).
@ -547,7 +547,7 @@ fu_bluez_device_notify_start (FuBluezDevice *self, const gchar *uuid, GError **e
* fu_bluez_device_notify_stop: * fu_bluez_device_notify_stop:
* @self: A #FuBluezDevice * @self: A #FuBluezDevice
* @uuid: The UUID, e.g. `00cde35c-7062-11eb-9439-0242ac130002` * @uuid: The UUID, e.g. `00cde35c-7062-11eb-9439-0242ac130002`
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Disables notifications for property changes in a UUID (StopNotify * Disables notifications for property changes in a UUID (StopNotify
* method). * method).

8
libfwupdplugin/fu-cabinet.c
View File

@ -175,7 +175,7 @@ fu_cabinet_add_file (FuCabinet *self, const gchar *basename, GBytes *data)
* fu_cabinet_get_file: * fu_cabinet_get_file:
* @self: A #FuCabinet * @self: A #FuCabinet
* @basename: filename * @basename: filename
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets a file from the archive. * Gets a file from the archive.
* *
@ -737,7 +737,7 @@ fu_cabinet_decompress (FuCabinet *self, GBytes *data, GError **error)
* fu_cabinet_export: * fu_cabinet_export:
* @self: A #FuCabinet * @self: A #FuCabinet
* @flags: A #FuCabinetExportFlags, e.g. %FU_CABINET_EXPORT_FLAG_NONE * @flags: A #FuCabinetExportFlags, e.g. %FU_CABINET_EXPORT_FLAG_NONE
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Exports the cabinet archive. * Exports the cabinet archive.
* *
@ -872,7 +872,7 @@ fu_cabinet_sign_enumerate_firmware (FuCabinet *self, GPtrArray *files, GError **
* @cert: A #GBytes of a PCKS#7 certificate * @cert: A #GBytes of a PCKS#7 certificate
* @privkey: A #GBytes of a private key * @privkey: A #GBytes of a private key
* @flags: A #FuCabinetSignFlags, e.g. %FU_CABINET_SIGN_FLAG_NONE * @flags: A #FuCabinetSignFlags, e.g. %FU_CABINET_SIGN_FLAG_NONE
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Sign the cabinet archive using JCat. * Sign the cabinet archive using JCat.
* *
@ -945,7 +945,7 @@ fu_cabinet_sign (FuCabinet *self,
* @self: A #FuCabinet * @self: A #FuCabinet
* @data: A #GBytes * @data: A #GBytes
* @flags: A #FuCabinetParseFlags, e.g. %FU_CABINET_PARSE_FLAG_NONE * @flags: A #FuCabinetParseFlags, e.g. %FU_CABINET_PARSE_FLAG_NONE
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Parses the cabinet archive. * Parses the cabinet archive.
* *

32
libfwupdplugin/fu-chunk.c
View File

@ -56,7 +56,7 @@ fu_chunk_set_idx (FuChunk *self, guint32 idx)
* *
* Gets the index of the chunk. * Gets the index of the chunk.
* *
* Return value: index * Returns: index
* *
* Since: 1.5.6 * Since: 1.5.6
**/ **/
@ -89,7 +89,7 @@ fu_chunk_set_page (FuChunk *self, guint32 page)
* *
* Gets the page of the chunk. * Gets the page of the chunk.
* *
* Return value: page * Returns: page
* *
* Since: 1.5.6 * Since: 1.5.6
**/ **/
@ -122,7 +122,7 @@ fu_chunk_set_address (FuChunk *self, guint32 address)
* *
* Gets the address of the chunk. * Gets the address of the chunk.
* *
* Return value: address * Returns: address
* *
* Since: 1.5.6 * Since: 1.5.6
**/ **/
@ -139,7 +139,7 @@ fu_chunk_get_address (FuChunk *self)
* *
* Gets the data of the chunk. * Gets the data of the chunk.
* *
* Return value: bytes * Returns: bytes
* *
* Since: 1.5.6 * Since: 1.5.6
**/ **/
@ -161,7 +161,7 @@ fu_chunk_get_data (FuChunk *self)
* fu_chunk_array_new() is also writable (i.e. not `const` or `mmap`) before * fu_chunk_array_new() is also writable (i.e. not `const` or `mmap`) before
* using this function. * using this function.
* *
* Return value: (transfer none): bytes * Returns: (transfer none): bytes
* *
* Since: 1.5.6 * Since: 1.5.6
**/ **/
@ -184,7 +184,7 @@ fu_chunk_get_data_out (FuChunk *self)
* *
* Gets the data size of the chunk. * Gets the data size of the chunk.
* *
* Return value: size in bytes * Returns: size in bytes
* *
* Since: 1.5.6 * Since: 1.5.6
**/ **/
@ -198,7 +198,7 @@ fu_chunk_get_data_sz (FuChunk *self)
/** /**
* fu_chunk_set_bytes: * fu_chunk_set_bytes:
* @self: a #FuChunk * @self: a #FuChunk
* @bytes: (nullable): a #GBytes, or %NULL * @bytes: (nullable): a #GBytes
* *
* Sets the GBytes blob * Sets the GBytes blob
* *
@ -230,7 +230,7 @@ fu_chunk_set_bytes (FuChunk *self, GBytes *bytes)
* *
* Gets the data as bytes of the chunk. * Gets the data as bytes of the chunk.
* *
* Return value: (transfer full): a #GBytes * Returns: (transfer full): a #GBytes
* *
* Since: 1.5.6 * Since: 1.5.6
**/ **/
@ -253,7 +253,7 @@ fu_chunk_get_bytes (FuChunk *self)
* *
* Creates a new packet of chunked data. * Creates a new packet of chunked data.
* *
* Return value: (transfer full): a #FuChunk * Returns: (transfer full): a #FuChunk
* *
* Since: 1.1.2 * Since: 1.1.2
**/ **/
@ -279,7 +279,7 @@ fu_chunk_new (guint32 idx,
* *
* Creates a new packet of data. * Creates a new packet of data.
* *
* Return value: (transfer full): a #FuChunk * Returns: (transfer full): a #FuChunk
* *
* Since: 1.5.6 * Since: 1.5.6
**/ **/
@ -317,7 +317,7 @@ fu_chunk_export (FuChunk *self, FuFirmwareExportFlags flags, XbBuilderNode *bn)
* *
* Converts the chunked packet to a string representation. * Converts the chunked packet to a string representation.
* *
* Return value: (transfer full): A string * Returns: (transfer full): A string
* *
* Since: 1.1.2 * Since: 1.1.2
**/ **/
@ -341,7 +341,7 @@ fu_chunk_to_string (FuChunk *self)
* *
* 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 * Returns: (transfer full): A string
* *
* Since: 1.0.1 * Since: 1.0.1
**/ **/
@ -374,7 +374,7 @@ fu_chunk_array_to_string (GPtrArray *chunks)
* Chunks a mutable blob of memory into packets, ensuring each packet does not * Chunks a mutable blob of memory into packets, ensuring each packet does not
* cross a package boundary and is less that a specific transfer size. * cross a package boundary and is less that a specific transfer size.
* *
* Return value: (transfer container) (element-type FuChunk): array of packets * Returns: (transfer container) (element-type FuChunk): array of packets
* *
* Since: 1.5.6 * Since: 1.5.6
**/ **/
@ -402,7 +402,7 @@ fu_chunk_array_mutable_new (guint8 *data,
/** /**
* fu_chunk_array_new: * fu_chunk_array_new:
* @data: a linear blob of memory, or %NULL * @data: (nullable): an optional linear blob of memory
* @data_sz: size of @data_sz * @data_sz: size of @data_sz
* @addr_start: the hardware address offset, or 0 * @addr_start: the hardware address offset, or 0
* @page_sz: the hardware page size, or 0 * @page_sz: the hardware page size, or 0
@ -411,7 +411,7 @@ fu_chunk_array_mutable_new (guint8 *data,
* Chunks a linear blob of memory into packets, ensuring each packet does not * Chunks a linear blob of memory into packets, ensuring each packet does not
* cross a package boundary and is less that a specific transfer size. * cross a package boundary and is less that a specific transfer size.
* *
* Return value: (transfer container) (element-type FuChunk): array of packets * Returns: (transfer container) (element-type FuChunk): array of packets
* *
* Since: 1.1.2 * Since: 1.1.2
**/ **/
@ -494,7 +494,7 @@ fu_chunk_array_new (const guint8 *data,
* Chunks a linear blob of memory into packets, ensuring each packet does not * Chunks a linear blob of memory into packets, ensuring each packet does not
* cross a package boundary and is less that a specific transfer size. * cross a package boundary and is less that a specific transfer size.
* *
* Return value: (transfer container) (element-type FuChunk): array of packets * Returns: (transfer container) (element-type FuChunk): array of packets
* *
* Since: 1.1.2 * Since: 1.1.2
**/ **/

2
libfwupdplugin/fu-common-version.c
View File

@ -420,7 +420,7 @@ fu_common_version_convert_base (FwupdVersionFormat fmt)
* fu_common_version_verify_format: * fu_common_version_verify_format:
* @version: A string, e.g. "0x1234" * @version: A string, e.g. "0x1234"
* @fmt: a #FwupdVersionFormat * @fmt: a #FwupdVersionFormat
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Verifies if a version matches the input format. * Verifies if a version matches the input format.
* *

128
libfwupdplugin/fu-common.c
View File

@ -62,7 +62,7 @@
/** /**
* fu_common_rmtree: * fu_common_rmtree:
* @directory: a directory name * @directory: a directory name
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Recursively removes a directory. * Recursively removes a directory.
* *
@ -140,7 +140,7 @@ fu_common_get_file_list_internal (GPtrArray *files, const gchar *directory, GErr
/** /**
* fu_common_get_files_recursive: * fu_common_get_files_recursive:
* @path: a directory name * @path: a directory name
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Returns every file found under @directory, and any subdirectory. * Returns every file found under @directory, and any subdirectory.
* If any path under @directory cannot be accessed due to permissions an error * If any path under @directory cannot be accessed due to permissions an error
@ -165,7 +165,7 @@ fu_common_get_files_recursive (const gchar *path, GError **error)
/** /**
* fu_common_mkdir_parent: * fu_common_mkdir_parent:
* @filename: A full pathname * @filename: A full pathname
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Creates any required directories, including any parent directories. * Creates any required directories, including any parent directories.
* *
@ -199,7 +199,7 @@ fu_common_mkdir_parent (const gchar *filename, GError **error)
* fu_common_set_contents_bytes: * fu_common_set_contents_bytes:
* @filename: A filename * @filename: A filename
* @bytes: The data to write * @bytes: The data to write
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Writes a blob of data to a filename, creating the parent directories as * Writes a blob of data to a filename, creating the parent directories as
* required. * required.
@ -234,7 +234,7 @@ fu_common_set_contents_bytes (const gchar *filename, GBytes *bytes, GError **err
/** /**
* fu_common_get_contents_bytes: * fu_common_get_contents_bytes:
* @filename: A filename * @filename: A filename
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Reads a blob of data from a file. * Reads a blob of data from a file.
* *
@ -261,7 +261,7 @@ fu_common_get_contents_bytes (const gchar *filename, GError **error)
* fu_common_get_contents_fd: * fu_common_get_contents_fd:
* @fd: A file descriptor * @fd: A file descriptor
* @count: The maximum number of bytes to read * @count: The maximum number of bytes to read
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Reads a blob from a specific file descriptor. * Reads a blob from a specific file descriptor.
* *
@ -351,7 +351,7 @@ fu_common_extract_archive_entry (struct archive_entry *entry, const gchar *dir)
* fu_common_extract_archive: * fu_common_extract_archive:
* @blob: a #GBytes archive as a blob * @blob: a #GBytes archive as a blob
* @dir: a directory name to extract to * @dir: a directory name to extract to
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Extracts an archive to a directory. * Extracts an archive to a directory.
* *
@ -456,7 +456,7 @@ fu_common_add_argv (GPtrArray *argv, const gchar *fmt, ...)
/** /**
* fu_common_find_program_in_path: * fu_common_find_program_in_path:
* @basename: The program to search * @basename: The program to search
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Looks for a program in the PATH variable * Looks for a program in the PATH variable
* *
@ -510,7 +510,7 @@ fu_common_test_namespace_support (GError **error)
* @bytes: The data to use * @bytes: The data to use
* @script_fn: Name of the script to run in the tarball, e.g. `startup.sh` * @script_fn: Name of the script to run in the tarball, e.g. `startup.sh`
* @output_fn: Name of the generated firmware, e.g. `firmware.bin` * @output_fn: Name of the generated firmware, e.g. `firmware.bin`
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Builds a firmware file using tools from the host session in a bubblewrap * Builds a firmware file using tools from the host session in a bubblewrap
* jail. Several things happen during build: * jail. Several things happen during build:
@ -734,11 +734,11 @@ fu_common_spawn_cancelled_cb (GCancellable *cancellable, FuCommonSpawnHelper *he
/** /**
* fu_common_spawn_sync: * fu_common_spawn_sync:
* @argv: The argument list to run * @argv: The argument list to run
* @handler_cb: (scope call): A #FuOutputHandler or %NULL * @handler_cb: (scope call) (nullable): optional #FuOutputHandler
* @handler_user_data: the user data to pass to @handler_cb * @handler_user_data: (nullable): the user data to pass to @handler_cb
* @timeout_ms: a timeout in ms, or 0 for no limit * @timeout_ms: a timeout in ms, or 0 for no limit
* @cancellable: a #GCancellable, or %NULL * @cancellable: (nullable): optional #GCancellable
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Runs a subprocess and waits for it to exit. Any output on standard out or * Runs a subprocess and waits for it to exit. Any output on standard out or
* standard error will be forwarded to @handler_cb as whole lines. * standard error will be forwarded to @handler_cb as whole lines.
@ -1470,8 +1470,8 @@ fu_common_string_append_kb (GString *str, guint idt, const gchar *key, gboolean
/** /**
* fu_common_dump_full: * fu_common_dump_full:
* @log_domain: log domain, typically %G_LOG_DOMAIN or %NULL * @log_domain: (nullable): optional log domain, typically %G_LOG_DOMAIN
* @title: prefix title, or %NULL * @title: (nullable): optional prefix title
* @data: buffer to print * @data: buffer to print
* @len: the size of @data * @len: the size of @data
* @columns: break new lines after this many bytes * @columns: break new lines after this many bytes
@ -1538,8 +1538,8 @@ fu_common_dump_full (const gchar *log_domain,
/** /**
* fu_common_dump_raw: * fu_common_dump_raw:
* @log_domain: log domain, typically %G_LOG_DOMAIN or %NULL * @log_domain: (nullable): optional log domain, typically %G_LOG_DOMAIN
* @title: prefix title, or %NULL * @title: (nullable): optional prefix title
* @data: buffer to print * @data: buffer to print
* @len: the size of @data * @len: the size of @data
* *
@ -1561,8 +1561,8 @@ fu_common_dump_raw (const gchar *log_domain,
/** /**
* fu_common_dump_bytes: * fu_common_dump_bytes:
* @log_domain: log domain, typically %G_LOG_DOMAIN or %NULL * @log_domain: (nullable): optional log domain, typically %G_LOG_DOMAIN
* @title: prefix title, or %NULL * @title: (nullable): optional prefix title
* @bytes: a #GBytes * @bytes: a #GBytes
* *
* Dumps a byte buffer to the screen. * Dumps a byte buffer to the screen.
@ -1623,7 +1623,7 @@ fu_common_bytes_align (GBytes *bytes, gsize blksz, gchar padval)
* *
* Checks if a byte array are just empty (0xff) bytes. * Checks if a byte array are just empty (0xff) bytes.
* *
* Return value: %TRUE if @bytes is empty * Returns: %TRUE if @bytes is empty
* *
* Since: 1.2.6 * Since: 1.2.6
**/ **/
@ -1645,11 +1645,11 @@ fu_common_bytes_is_empty (GBytes *bytes)
* @bufsz1: sizeof @buf1 * @bufsz1: sizeof @buf1
* @buf2: another buffer * @buf2: another buffer
* @bufsz2: sizeof @buf2 * @bufsz2: sizeof @buf2
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Compares the buffers for equality. * Compares the buffers for equality.
* *
* Return value: %TRUE if @buf1 and @buf2 are identical * Returns: %TRUE if @buf1 and @buf2 are identical
* *
* Since: 1.3.2 * Since: 1.3.2
**/ **/
@ -1692,11 +1692,11 @@ fu_common_bytes_compare_raw (const guint8 *buf1, gsize bufsz1,
* fu_common_bytes_compare: * fu_common_bytes_compare:
* @bytes1: a #GBytes * @bytes1: a #GBytes
* @bytes2: another #GBytes * @bytes2: another #GBytes
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Compares the buffers for equality. * Compares the buffers for equality.
* *
* Return value: %TRUE if @bytes1 and @bytes2 are identical * Returns: %TRUE if @bytes1 and @bytes2 are identical
* *
* Since: 1.2.6 * Since: 1.2.6
**/ **/
@ -1724,7 +1724,7 @@ fu_common_bytes_compare (GBytes *bytes1, GBytes *bytes2, GError **error)
* *
* Pads a GBytes to a minimum @sz with `0xff`. * Pads a GBytes to a minimum @sz with `0xff`.
* *
* Return value: (transfer full): a #GBytes * Returns: (transfer full): a #GBytes
* *
* Since: 1.3.1 * Since: 1.3.1
**/ **/
@ -1755,11 +1755,11 @@ fu_common_bytes_pad (GBytes *bytes, gsize sz)
* @bytes: a #GBytes * @bytes: a #GBytes
* @offset: where subsection starts at * @offset: where subsection starts at
* @length: length of subsection * @length: length of subsection
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Creates a #GBytes which is a subsection of another #GBytes. * Creates a #GBytes which is a subsection of another #GBytes.
* *
* Return value: (transfer full): a #GBytes, or #NULL if range is invalid * Returns: (transfer full): a #GBytes, or #NULL if range is invalid
* *
* Since: 1.5.4 * Since: 1.5.4
**/ **/
@ -1790,11 +1790,11 @@ fu_common_bytes_new_offset (GBytes *bytes,
/** /**
* fu_common_realpath: * fu_common_realpath:
* @filename: a filename * @filename: a filename
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Finds the canonicalized absolute filename for a path. * Finds the canonicalized absolute filename for a path.
* *
* Return value: A filename, or %NULL if invalid or not found * Returns: A filename, or %NULL if invalid or not found
* *
* Since: 1.2.6 * Since: 1.2.6
**/ **/
@ -1836,7 +1836,7 @@ fu_common_realpath (const gchar *filename, GError **error)
* *
* Matches a string against a glob pattern. * Matches a string against a glob pattern.
* *
* Return value: %TRUE if the string matched * Returns: %TRUE if the string matched
* *
* Since: 1.3.5 * Since: 1.3.5
**/ **/
@ -1866,12 +1866,12 @@ fu_common_filename_glob_sort_cb (gconstpointer a, gconstpointer b)
* fu_common_filename_glob: * fu_common_filename_glob:
* @directory: a directory path * @directory: a directory path
* @pattern: a glob pattern, e.g. `*foo*` * @pattern: a glob pattern, e.g. `*foo*`
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Returns all the filenames that match a specific glob pattern. * Returns all the filenames that match a specific glob pattern.
* Any results are sorted. No matching files will set @error. * Any results are sorted. No matching files will set @error.
* *
* Return value: (element-type utf8) (transfer container): matching files, or %NULL * Returns: (element-type utf8) (transfer container): matching files, or %NULL
* *
* Since: 1.5.0 * Since: 1.5.0
**/ **/
@ -1916,7 +1916,7 @@ fu_common_filename_glob (const gchar *directory, const gchar *pattern, GError **
* delimiter. If @max_tokens is reached, the remainder of string is appended * delimiter. If @max_tokens is reached, the remainder of string is appended
* to the last token. * to the last token.
* *
* Return value: (transfer full): a newly-allocated NULL-terminated array of strings * Returns: (transfer full): a newly-allocated NULL-terminated array of strings
* *
* Since: 1.3.1 * Since: 1.3.1
**/ **/
@ -1938,7 +1938,7 @@ fu_common_strnsplit (const gchar *str, gsize sz,
* *
* Converts a string into something that can be safely printed. * Converts a string into something that can be safely printed.
* *
* Return value: (transfer full): safe string, or %NULL if there was nothing valid * Returns: (transfer full): safe string, or %NULL if there was nothing valid
* *
* Since: 1.5.5 * Since: 1.5.5
**/ **/
@ -1973,7 +1973,7 @@ fu_common_strsafe (const gchar *str, gsize maxsz)
/** /**
* fu_common_strjoin_array: * fu_common_strjoin_array:
* @separator: (nullable): string to insert between each of the strings, or %NULL * @separator: (nullable): string to insert between each of the strings
* @array: (element-type utf8): A #GPtrArray * @array: (element-type utf8): A #GPtrArray
* *
* Joins an array of strings together to form one long string, with the optional * Joins an array of strings together to form one long string, with the optional
@ -2009,7 +2009,7 @@ fu_common_strjoin_array (const gchar *separator, GPtrArray *array)
* @src_sz: maximum size of @dst, typically `sizeof(src)` * @src_sz: maximum size of @dst, typically `sizeof(src)`
* @src_offset: offset in bytes into @src to copy from * @src_offset: offset in bytes into @src to copy from
* @n: number of bytes to copy from @src+@offset from * @n: number of bytes to copy from @src+@offset from
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Copies some memory using memcpy in a safe way. Providing the buffer sizes * Copies some memory using memcpy in a safe way. Providing the buffer sizes
* of both the destination and the source allows us to check for buffer overflow. * of both the destination and the source allows us to check for buffer overflow.
@ -2022,7 +2022,7 @@ fu_common_strjoin_array (const gchar *separator, GPtrArray *array)
* you use it when performance is a concern. Only us it when you're not sure if * you use it when performance is a concern. Only us it when you're not sure if
* malicious data from a device or firmware could cause memory corruption. * malicious data from a device or firmware could cause memory corruption.
* *
* Return value: %TRUE if the bytes were copied, %FALSE otherwise * Returns: %TRUE if the bytes were copied, %FALSE otherwise
* *
* Since: 1.3.1 * Since: 1.3.1
**/ **/
@ -2080,7 +2080,7 @@ fu_memcpy_safe (guint8 *dst, gsize dst_sz, gsize dst_offset,
* fu_memdup_safe: * fu_memdup_safe:
* @src: source buffer * @src: source buffer
* @n: number of bytes to copy from @src * @n: number of bytes to copy from @src
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Duplicates some memory using memdup in a safe way. * Duplicates some memory using memdup in a safe way.
* *
@ -2090,7 +2090,7 @@ fu_memcpy_safe (guint8 *dst, gsize dst_sz, gsize dst_offset,
* *
* NOTE: This function intentionally limits allocation size to 1GB. * NOTE: This function intentionally limits allocation size to 1GB.
* *
* Return value: (transfer full): block of allocated memory, or %NULL for an error. * Returns: (transfer full): block of allocated memory, or %NULL for an error.
* *
* Since: 1.5.6 * Since: 1.5.6
**/ **/
@ -2121,7 +2121,7 @@ fu_memdup_safe (const guint8 *src, gsize n, GError **error)
* @bufsz: maximum size of @buf, typically `sizeof(buf)` * @bufsz: maximum size of @buf, typically `sizeof(buf)`
* @offset: offset in bytes into @buf to copy from * @offset: offset in bytes into @buf to copy from
* @value: (out) (nullable): the parsed value * @value: (out) (nullable): the parsed value
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Read a value from a buffer in a safe way. * Read a value from a buffer in a safe way.
* *
@ -2129,7 +2129,7 @@ fu_memdup_safe (const guint8 *src, gsize n, GError **error)
* you use it when performance is a concern. Only us it when you're not sure if * you use it when performance is a concern. Only us it when you're not sure if
* malicious data from a device or firmware could cause memory corruption. * malicious data from a device or firmware could cause memory corruption.
* *
* Return value: %TRUE if @value was set, %FALSE otherwise * Returns: %TRUE if @value was set, %FALSE otherwise
* *
* Since: 1.3.3 * Since: 1.3.3
**/ **/
@ -2161,7 +2161,7 @@ fu_common_read_uint8_safe (const guint8 *buf,
* @offset: offset in bytes into @buf to copy from * @offset: offset in bytes into @buf to copy from
* @value: (out) (nullable): the parsed value * @value: (out) (nullable): the parsed value
* @endian: A #FuEndianType, e.g. %G_LITTLE_ENDIAN * @endian: A #FuEndianType, e.g. %G_LITTLE_ENDIAN
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Read a value from a buffer using a specified endian in a safe way. * Read a value from a buffer using a specified endian in a safe way.
* *
@ -2169,7 +2169,7 @@ fu_common_read_uint8_safe (const guint8 *buf,
* you use it when performance is a concern. Only us it when you're not sure if * you use it when performance is a concern. Only us it when you're not sure if
* malicious data from a device or firmware could cause memory corruption. * malicious data from a device or firmware could cause memory corruption.
* *
* Return value: %TRUE if @value was set, %FALSE otherwise * Returns: %TRUE if @value was set, %FALSE otherwise
* *
* Since: 1.3.3 * Since: 1.3.3
**/ **/
@ -2202,7 +2202,7 @@ fu_common_read_uint16_safe (const guint8 *buf,
* @offset: offset in bytes into @buf to copy from * @offset: offset in bytes into @buf to copy from
* @value: (out) (nullable): the parsed value * @value: (out) (nullable): the parsed value
* @endian: A #FuEndianType, e.g. %G_LITTLE_ENDIAN * @endian: A #FuEndianType, e.g. %G_LITTLE_ENDIAN
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Read a value from a buffer using a specified endian in a safe way. * Read a value from a buffer using a specified endian in a safe way.
* *
@ -2210,7 +2210,7 @@ fu_common_read_uint16_safe (const guint8 *buf,
* you use it when performance is a concern. Only us it when you're not sure if * you use it when performance is a concern. Only us it when you're not sure if
* malicious data from a device or firmware could cause memory corruption. * malicious data from a device or firmware could cause memory corruption.
* *
* Return value: %TRUE if @value was set, %FALSE otherwise * Returns: %TRUE if @value was set, %FALSE otherwise
* *
* Since: 1.3.3 * Since: 1.3.3
**/ **/
@ -2243,7 +2243,7 @@ fu_common_read_uint32_safe (const guint8 *buf,
* @offset: offset in bytes into @buf to copy from * @offset: offset in bytes into @buf to copy from
* @value: (out) (nullable): the parsed value * @value: (out) (nullable): the parsed value
* @endian: A #FuEndianType, e.g. %G_LITTLE_ENDIAN * @endian: A #FuEndianType, e.g. %G_LITTLE_ENDIAN
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Read a value from a buffer using a specified endian in a safe way. * Read a value from a buffer using a specified endian in a safe way.
* *
@ -2251,7 +2251,7 @@ fu_common_read_uint32_safe (const guint8 *buf,
* you use it when performance is a concern. Only us it when you're not sure if * you use it when performance is a concern. Only us it when you're not sure if
* malicious data from a device or firmware could cause memory corruption. * malicious data from a device or firmware could cause memory corruption.
* *
* Return value: %TRUE if @value was set, %FALSE otherwise * Returns: %TRUE if @value was set, %FALSE otherwise
* *
* Since: 1.5.8 * Since: 1.5.8
**/ **/
@ -2283,7 +2283,7 @@ fu_common_read_uint64_safe (const guint8 *buf,
* @bufsz: maximum size of @buf, typically `sizeof(buf)` * @bufsz: maximum size of @buf, typically `sizeof(buf)`
* @offset: offset in bytes into @buf to write to * @offset: offset in bytes into @buf to write to
* @value: the value to write * @value: the value to write
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Write a value to a buffer in a safe way. * Write a value to a buffer in a safe way.
* *
@ -2291,7 +2291,7 @@ fu_common_read_uint64_safe (const guint8 *buf,
* you use it when performance is a concern. Only us it when you're not sure if * you use it when performance is a concern. Only us it when you're not sure if
* malicious data from a device or firmware could cause memory corruption. * malicious data from a device or firmware could cause memory corruption.
* *
* Return value: %TRUE if @value was written, %FALSE otherwise * Returns: %TRUE if @value was written, %FALSE otherwise
* *
* Since: 1.5.8 * Since: 1.5.8
**/ **/
@ -2317,7 +2317,7 @@ fu_common_write_uint8_safe (guint8 *buf,
* @offset: offset in bytes into @buf to write to * @offset: offset in bytes into @buf to write to
* @value: the value to write * @value: the value to write
* @endian: A #FuEndianType, e.g. %G_LITTLE_ENDIAN * @endian: A #FuEndianType, e.g. %G_LITTLE_ENDIAN
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Write a value to a buffer using a specified endian in a safe way. * Write a value to a buffer using a specified endian in a safe way.
* *
@ -2325,7 +2325,7 @@ fu_common_write_uint8_safe (guint8 *buf,
* you use it when performance is a concern. Only us it when you're not sure if * you use it when performance is a concern. Only us it when you're not sure if
* malicious data from a device or firmware could cause memory corruption. * malicious data from a device or firmware could cause memory corruption.
* *
* Return value: %TRUE if @value was written, %FALSE otherwise * Returns: %TRUE if @value was written, %FALSE otherwise
* *
* Since: 1.5.8 * Since: 1.5.8
**/ **/
@ -2355,7 +2355,7 @@ fu_common_write_uint16_safe (guint8 *buf,
* @offset: offset in bytes into @buf to write to * @offset: offset in bytes into @buf to write to
* @value: the value to write * @value: the value to write
* @endian: A #FuEndianType, e.g. %G_LITTLE_ENDIAN * @endian: A #FuEndianType, e.g. %G_LITTLE_ENDIAN
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Write a value to a buffer using a specified endian in a safe way. * Write a value to a buffer using a specified endian in a safe way.
* *
@ -2363,7 +2363,7 @@ fu_common_write_uint16_safe (guint8 *buf,
* you use it when performance is a concern. Only us it when you're not sure if * you use it when performance is a concern. Only us it when you're not sure if
* malicious data from a device or firmware could cause memory corruption. * malicious data from a device or firmware could cause memory corruption.
* *
* Return value: %TRUE if @value was written, %FALSE otherwise * Returns: %TRUE if @value was written, %FALSE otherwise
* *
* Since: 1.5.8 * Since: 1.5.8
**/ **/
@ -2393,7 +2393,7 @@ fu_common_write_uint32_safe (guint8 *buf,
* @offset: offset in bytes into @buf to write to * @offset: offset in bytes into @buf to write to
* @value: the value to write * @value: the value to write
* @endian: A #FuEndianType, e.g. %G_LITTLE_ENDIAN * @endian: A #FuEndianType, e.g. %G_LITTLE_ENDIAN
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Write a value to a buffer using a specified endian in a safe way. * Write a value to a buffer using a specified endian in a safe way.
* *
@ -2401,7 +2401,7 @@ fu_common_write_uint32_safe (guint8 *buf,
* you use it when performance is a concern. Only us it when you're not sure if * you use it when performance is a concern. Only us it when you're not sure if
* malicious data from a device or firmware could cause memory corruption. * malicious data from a device or firmware could cause memory corruption.
* *
* Return value: %TRUE if @value was written, %FALSE otherwise * Returns: %TRUE if @value was written, %FALSE otherwise
* *
* Since: 1.5.8 * Since: 1.5.8
**/ **/
@ -2604,11 +2604,11 @@ fu_common_kernel_locked_down (void)
* @ebx: (out) (nullable): EBX register * @ebx: (out) (nullable): EBX register
* @ecx: (out) (nullable): ECX register * @ecx: (out) (nullable): ECX register
* @edx: (out) (nullable): EDX register * @edx: (out) (nullable): EDX register
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Calls CPUID and returns the registers for the given leaf. * Calls CPUID and returns the registers for the given leaf.
* *
* Return value: %TRUE if the registers are set. * Returns: %TRUE if the registers are set.
* *
* Since: 1.5.0 * Since: 1.5.0
**/ **/
@ -2653,7 +2653,7 @@ fu_common_cpuid (guint32 leaf,
* *
* Uses CPUID to discover the CPU vendor. * Uses CPUID to discover the CPU vendor.
* *
* Return value: a #FuCpuVendor, e.g. %FU_CPU_VENDOR_AMD if the vendor was AMD. * Returns: a #FuCpuVendor, e.g. %FU_CPU_VENDOR_AMD if the vendor was AMD.
* *
* Since: 1.5.5 * Since: 1.5.5
**/ **/
@ -2821,7 +2821,7 @@ fu_common_convert_to_gpt_type (const gchar *type)
/** /**
* fu_common_get_volumes_by_kind: * fu_common_get_volumes_by_kind:
* @kind: A volume kind, typically a GUID * @kind: A volume kind, typically a GUID
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Finds all volumes of a specific partition type * Finds all volumes of a specific partition type
* *
@ -2905,7 +2905,7 @@ fu_common_get_volumes_by_kind (const gchar *kind, GError **error)
/** /**
* fu_common_get_volume_by_device: * fu_common_get_volume_by_device:
* @device: A device string, typcically starting with `/dev/` * @device: A device string, typcically starting with `/dev/`
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Finds the first volume from the specified device. * Finds the first volume from the specified device.
* *
@ -2950,7 +2950,7 @@ fu_common_get_volume_by_device (const gchar *device, GError **error)
/** /**
* fu_common_get_volume_by_devnum: * fu_common_get_volume_by_devnum:
* @devnum: A device number * @devnum: A device number
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Finds the first volume from the specified device. * Finds the first volume from the specified device.
* *
@ -2993,7 +2993,7 @@ fu_common_get_volume_by_devnum (guint32 devnum, GError **error)
/** /**
* fu_common_get_esp_default: * fu_common_get_esp_default:
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Gets the platform default ESP * Gets the platform default ESP
* *
@ -3081,7 +3081,7 @@ fu_common_get_esp_default (GError **error)
/** /**
* fu_common_get_esp_for_path: * fu_common_get_esp_for_path:
* @esp_path: A path to the ESP * @esp_path: A path to the ESP
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Gets the platform ESP using a UNIX or UDisks path * Gets the platform ESP using a UNIX or UDisks path
* *
@ -3310,7 +3310,7 @@ fu_battery_state_to_string (FuBatteryState battery_state)
* fu_bytes_get_data_safe: * fu_bytes_get_data_safe:
* @bytes: a #GBytes * @bytes: a #GBytes
* @bufsz: (out) (optional): location to return size of byte data * @bufsz: (out) (optional): location to return size of byte data
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Get the byte data in the #GBytes. This data should not be modified. * Get the byte data in the #GBytes. This data should not be modified.
* This function will always return the same pointer for a given #GBytes. * This function will always return the same pointer for a given #GBytes.

6
libfwupdplugin/fu-context.c
View File

@ -180,7 +180,7 @@ fu_context_get_hwid_value (FuContext *self, const gchar *key)
* fu_context_get_hwid_replace_value: * fu_context_get_hwid_replace_value:
* @self: A #FuContext * @self: A #FuContext
* @keys: A key, e.g. `HardwareID-3` or %FU_HWIDS_KEY_PRODUCT_SKU * @keys: A key, e.g. `HardwareID-3` or %FU_HWIDS_KEY_PRODUCT_SKU
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the replacement value for a specific key. All hardware IDs on a * Gets the replacement value for a specific key. All hardware IDs on a
* specific system can be shown using the `fwupdmgr hwids` command. * specific system can be shown using the `fwupdmgr hwids` command.
@ -502,7 +502,7 @@ fu_context_security_changed (FuContext *self)
/** /**
* fu_context_load_hwinfo: * fu_context_load_hwinfo:
* @self: A #FuContext * @self: A #FuContext
* @error: (nullable): A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Loads all hardware information parts of the context. * Loads all hardware information parts of the context.
* *
@ -533,7 +533,7 @@ fu_context_load_hwinfo (FuContext *self, GError **error)
* fu_context_load_quirks: * fu_context_load_quirks:
* @self: A #FuContext * @self: A #FuContext
* @flags: a #FuQuirksLoadFlags, e.g. %FU_QUIRKS_LOAD_FLAG_READONLY_FS * @flags: a #FuQuirksLoadFlags, e.g. %FU_QUIRKS_LOAD_FLAG_READONLY_FS
* @error: (nullable): A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Loads all quirks into the context. * Loads all quirks into the context.
* *

6
libfwupdplugin/fu-device-locker.c
View File

@ -68,7 +68,7 @@ fu_device_locker_init (FuDeviceLocker *self)
/** /**
* fu_device_locker_close: * fu_device_locker_close:
* @self: A #FuDeviceLocker * @self: A #FuDeviceLocker
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Closes the locker before it gets cleaned up. * Closes the locker before it gets cleaned up.
* *
@ -111,7 +111,7 @@ fu_device_locker_close (FuDeviceLocker *self, GError **error)
/** /**
* fu_device_locker_new: * fu_device_locker_new:
* @device: A #GObject * @device: A #GObject
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Opens the device for use. When the #FuDeviceLocker is deallocated the device * Opens the device for use. When the #FuDeviceLocker is deallocated the device
* will be closed and any error will just be directed to the console. * will be closed and any error will just be directed to the console.
@ -167,7 +167,7 @@ fu_device_locker_new (gpointer device, GError **error)
* @device: A #GObject * @device: A #GObject
* @open_func: (scope async): A function to open the device * @open_func: (scope async): A function to open the device
* @close_func: (scope async): A function to close the device * @close_func: (scope async): A function to close the device
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Opens the device for use. When the #FuDeviceLocker is deallocated the device * Opens the device for use. When the #FuDeviceLocker is deallocated the device
* will be closed and any error will just be directed to the console. * will be closed and any error will just be directed to the console.

24
libfwupdplugin/fu-device.c
View File

@ -173,7 +173,7 @@ fu_device_set_property (GObject *object, guint prop_id,
* *
* Converts a #FuDeviceInternalFlags to a string. * Converts a #FuDeviceInternalFlags to a string.
* *
* Return value: identifier string * Returns: identifier string
* *
* Since: 1.5.5 * Since: 1.5.5
**/ **/
@ -209,7 +209,7 @@ fu_device_internal_flag_to_string (FuDeviceInternalFlags flag)
* *
* Converts a string to a #FuDeviceInternalFlags. * Converts a string to a #FuDeviceInternalFlags.
* *
* Return value: enumerated value * Returns: enumerated value
* *
* Since: 1.5.5 * Since: 1.5.5
**/ **/
@ -513,7 +513,7 @@ fu_device_retry (FuDevice *self,
/** /**
* fu_device_poll: * fu_device_poll:
* @self: A #FuDevice * @self: A #FuDevice
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Polls a device, typically querying the hardware for status. * Polls a device, typically querying the hardware for status.
* *
@ -2921,7 +2921,7 @@ fu_device_to_string (FuDevice *self)
/** /**
* fu_device_set_context: * fu_device_set_context:
* @self: A #FuDevice * @self: A #FuDevice
* @ctx: A #FuContext, or %NULL * @ctx: (nullable): optional #FuContext
* *
* Sets the optional context which may be useful to this device. * Sets the optional context which may be useful to this device.
* This is typically set after the #FuDevice has been created, but before * This is typically set after the #FuDevice has been created, but before
@ -3327,7 +3327,7 @@ fu_device_open_cb (FuDevice *self, gpointer user_data, GError **error)
/** /**
* fu_device_open: * fu_device_open:
* @self: A #FuDevice * @self: A #FuDevice
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Opens a device, optionally running a object-specific vfunc. * Opens a device, optionally running a object-specific vfunc.
* *
@ -3392,7 +3392,7 @@ fu_device_open (FuDevice *self, GError **error)
/** /**
* fu_device_close: * fu_device_close:
* @self: A #FuDevice * @self: A #FuDevice
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Closes a device, optionally running a object-specific vfunc. * Closes a device, optionally running a object-specific vfunc.
* *
@ -3442,7 +3442,7 @@ fu_device_close (FuDevice *self, GError **error)
/** /**
* fu_device_probe: * fu_device_probe:
* @self: A #FuDevice * @self: A #FuDevice
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Probes a device, setting parameters on the object that does not need * Probes a device, setting parameters on the object that does not need
* the device open or the interface claimed. * the device open or the interface claimed.
@ -3477,7 +3477,7 @@ fu_device_probe (FuDevice *self, GError **error)
/** /**
* fu_device_rescan: * fu_device_rescan:
* @self: A #FuDevice * @self: A #FuDevice
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Rescans a device, re-adding GUIDs or flags based on some hardware change. * Rescans a device, re-adding GUIDs or flags based on some hardware change.
* *
@ -3542,7 +3542,7 @@ fu_device_convert_instance_ids (FuDevice *self)
/** /**
* fu_device_setup: * fu_device_setup:
* @self: A #FuDevice * @self: A #FuDevice
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Sets up a device, setting parameters on the object that requires * Sets up a device, setting parameters on the object that requires
* the device to be open and have the interface claimed. * the device to be open and have the interface claimed.
@ -3590,7 +3590,7 @@ fu_device_setup (FuDevice *self, GError **error)
/** /**
* fu_device_activate: * fu_device_activate:
* @self: A #FuDevice * @self: A #FuDevice
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Activates up a device, which normally means the device switches to a new * Activates up a device, which normally means the device switches to a new
* firmware version. This should only be called when data loss cannot occur. * firmware version. This should only be called when data loss cannot occur.
@ -3720,7 +3720,7 @@ fu_device_add_security_attrs (FuDevice *self, FuSecurityAttrs *attrs)
* @self: A #FuDevice * @self: A #FuDevice
* @subsystem: A subsystem string, e.g. `pci` * @subsystem: A subsystem string, e.g. `pci`
* @driver: A kernel module name, e.g. `tg3` * @driver: A kernel module name, e.g. `tg3`
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Binds a driver to the device, which normally means the kernel driver takes * Binds a driver to the device, which normally means the kernel driver takes
* control of the hardware. * control of the hardware.
@ -3758,7 +3758,7 @@ fu_device_bind_driver (FuDevice *self,
/** /**
* fu_device_unbind_driver: * fu_device_unbind_driver:
* @self: A #FuDevice * @self: A #FuDevice
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Unbinds the driver from the device, which normally means the kernel releases * Unbinds the driver from the device, which normally means the kernel releases
* the hardware so it can be used from userspace. * the hardware so it can be used from userspace.

8
libfwupdplugin/fu-dfu-firmware.c
View File

@ -61,7 +61,7 @@ fu_dfu_firmware_get_footer_len (FuDfuFirmware *self)
* *
* Gets the vendor ID, or 0xffff for no restriction. * Gets the vendor ID, or 0xffff for no restriction.
* *
* Return value: integer * Returns: integer
* *
* Since: 1.3.3 * Since: 1.3.3
**/ **/
@ -79,7 +79,7 @@ fu_dfu_firmware_get_vid (FuDfuFirmware *self)
* *
* Gets the product ID, or 0xffff for no restriction. * Gets the product ID, or 0xffff for no restriction.
* *
* Return value: integer * Returns: integer
* *
* Since: 1.3.3 * Since: 1.3.3
**/ **/
@ -97,7 +97,7 @@ fu_dfu_firmware_get_pid (FuDfuFirmware *self)
* *
* Gets the device ID, or 0xffff for no restriction. * Gets the device ID, or 0xffff for no restriction.
* *
* Return value: integer * Returns: integer
* *
* Since: 1.3.3 * Since: 1.3.3
**/ **/
@ -115,7 +115,7 @@ fu_dfu_firmware_get_release (FuDfuFirmware *self)
* *
* Gets the file format version with is 0x0100 by default. * Gets the file format version with is 0x0100 by default.
* *
* Return value: integer * Returns: integer
* *
* Since: 1.3.3 * Since: 1.3.3
**/ **/

20
libfwupdplugin/fu-firmware-common.c
View File

@ -19,12 +19,12 @@
* @datasz: size of @data, typcally the same as `strlen(data)` * @datasz: size of @data, typcally the same as `strlen(data)`
* @offset: offset in chars into @data to read * @offset: offset in chars into @data to read
* @value: (out) (nullable): parsed value * @value: (out) (nullable): parsed value
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Parses a base 16 number from a string of 1 character in length. * Parses a base 16 number from a string of 1 character in length.
* The returned @value will range from from 0 to 0xf. * The returned @value will range from from 0 to 0xf.
* *
* Return value: %TRUE if parsed, %FALSE otherwise * Returns: %TRUE if parsed, %FALSE otherwise
* *
* Since: 1.5.6 * Since: 1.5.6
**/ **/
@ -51,12 +51,12 @@ fu_firmware_strparse_uint4_safe (const gchar *data,
* @datasz: size of @data, typcally the same as `strlen(data)` * @datasz: size of @data, typcally the same as `strlen(data)`
* @offset: offset in chars into @data to read * @offset: offset in chars into @data to read
* @value: (out) (nullable): parsed value * @value: (out) (nullable): parsed value
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Parses a base 16 number from a string of 2 characters in length. * Parses a base 16 number from a string of 2 characters in length.
* The returned @value will range from from 0 to 0xff. * The returned @value will range from from 0 to 0xff.
* *
* Return value: %TRUE if parsed, %FALSE otherwise * Returns: %TRUE if parsed, %FALSE otherwise
* *
* Since: 1.5.6 * Since: 1.5.6
**/ **/
@ -83,12 +83,12 @@ fu_firmware_strparse_uint8_safe (const gchar *data,
* @datasz: size of @data, typcally the same as `strlen(data)` * @datasz: size of @data, typcally the same as `strlen(data)`
* @offset: offset in chars into @data to read * @offset: offset in chars into @data to read
* @value: (out) (nullable): parsed value * @value: (out) (nullable): parsed value
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Parses a base 16 number from a string of 4 characters in length. * Parses a base 16 number from a string of 4 characters in length.
* The returned @value will range from from 0 to 0xffff. * The returned @value will range from from 0 to 0xffff.
* *
* Return value: %TRUE if parsed, %FALSE otherwise * Returns: %TRUE if parsed, %FALSE otherwise
* *
* Since: 1.5.6 * Since: 1.5.6
**/ **/
@ -115,12 +115,12 @@ fu_firmware_strparse_uint16_safe (const gchar *data,
* @datasz: size of @data, typcally the same as `strlen(data)` * @datasz: size of @data, typcally the same as `strlen(data)`
* @offset: offset in chars into @data to read * @offset: offset in chars into @data to read
* @value: (out) (nullable): parsed value * @value: (out) (nullable): parsed value
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Parses a base 16 number from a string of 6 characters in length. * Parses a base 16 number from a string of 6 characters in length.
* The returned @value will range from from 0 to 0xffffff. * The returned @value will range from from 0 to 0xffffff.
* *
* Return value: %TRUE if parsed, %FALSE otherwise * Returns: %TRUE if parsed, %FALSE otherwise
* *
* Since: 1.5.6 * Since: 1.5.6
**/ **/
@ -147,12 +147,12 @@ fu_firmware_strparse_uint24_safe (const gchar *data,
* @datasz: size of @data, typcally the same as `strlen(data)` * @datasz: size of @data, typcally the same as `strlen(data)`
* @offset: offset in chars into @data to read * @offset: offset in chars into @data to read
* @value: (out) (nullable): parsed value * @value: (out) (nullable): parsed value
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Parses a base 16 number from a string of 8 characters in length. * Parses a base 16 number from a string of 8 characters in length.
* The returned @value will range from from 0 to 0xffffffff. * The returned @value will range from from 0 to 0xffffffff.
* *
* Return value: %TRUE if parsed, %FALSE otherwise * Returns: %TRUE if parsed, %FALSE otherwise
* *
* Since: 1.5.6 * Since: 1.5.6
**/ **/

58
libfwupdplugin/fu-firmware.c
View File

@ -45,7 +45,7 @@ G_DEFINE_TYPE_WITH_PRIVATE (FuFirmware, fu_firmware, G_TYPE_OBJECT)
* *
* Converts a #FuFirmwareFlags to a string. * Converts a #FuFirmwareFlags to a string.
* *
* Return value: identifier string * Returns: identifier string
* *
* Since: 1.5.0 * Since: 1.5.0
**/ **/
@ -71,7 +71,7 @@ fu_firmware_flag_to_string (FuFirmwareFlags flag)
* *
* Converts a string to a #FuFirmwareFlags. * Converts a string to a #FuFirmwareFlags.
* *
* Return value: enumerated value * Returns: enumerated value
* *
* Since: 1.5.0 * Since: 1.5.0
**/ **/
@ -147,7 +147,7 @@ fu_firmware_get_version (FuFirmware *self)
/** /**
* fu_firmware_set_version: * fu_firmware_set_version:
* @self: A #FuFirmware * @self: A #FuFirmware
* @version: A string version, or %NULL * @version: (nullable): optional string version
* *
* Sets an optional version that represents the firmware. * Sets an optional version that represents the firmware.
* *
@ -227,7 +227,7 @@ fu_firmware_get_filename (FuFirmware *self)
/** /**
* fu_firmware_set_filename: * fu_firmware_set_filename:
* @self: A #FuFirmware * @self: A #FuFirmware
* @filename: (nullable): A string filename, or %NULL * @filename: (nullable): A string filename
* *
* Sets an optional filename that represents the image source or destination. * Sets an optional filename that represents the image source or destination.
* *
@ -459,7 +459,7 @@ fu_firmware_set_bytes (FuFirmware *self, GBytes *bytes)
/** /**
* fu_firmware_get_bytes: * fu_firmware_get_bytes:
* @self: a #FuPlugin * @self: a #FuPlugin
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the firmware payload, which does not have any header or footer included. * Gets the firmware payload, which does not have any header or footer included.
* *
@ -529,11 +529,11 @@ fu_firmware_get_alignment (FuFirmware *self)
/** /**
* fu_firmware_get_chunks: * fu_firmware_get_chunks:
* @self: a #FuFirmware * @self: a #FuFirmware
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the optional image chunks. * Gets the optional image chunks.
* *
* Return value: (transfer container) (element-type FuChunk) (nullable): chunk data, or %NULL * Returns: (transfer container) (element-type FuChunk) (nullable): chunk data, or %NULL
* *
* Since: 1.6.0 * Since: 1.6.0
**/ **/
@ -593,7 +593,7 @@ fu_firmware_add_chunk (FuFirmware *self, FuChunk *chk)
* fu_firmware_get_checksum: * fu_firmware_get_checksum:
* @self: a #FuPlugin * @self: a #FuPlugin
* @csum_kind: a #GChecksumType, e.g. %G_CHECKSUM_SHA256 * @csum_kind: a #GChecksumType, e.g. %G_CHECKSUM_SHA256
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Returns a checksum of the payload data. * Returns a checksum of the payload data.
* *
@ -633,7 +633,7 @@ fu_firmware_get_checksum (FuFirmware *self,
* @self: A #FuFirmware * @self: A #FuFirmware
* @fw: A #GBytes * @fw: A #GBytes
* @flags: some #FwupdInstallFlags, e.g. %FWUPD_INSTALL_FLAG_FORCE * @flags: some #FwupdInstallFlags, e.g. %FWUPD_INSTALL_FLAG_FORCE
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Tokenizes a firmware, typically breaking the firmware into records. * Tokenizes a firmware, typically breaking the firmware into records.
* *
@ -667,7 +667,7 @@ fu_firmware_tokenize (FuFirmware *self, GBytes *fw,
* @addr_start: Start address, useful for ignoring a bootloader * @addr_start: Start address, useful for ignoring a bootloader
* @addr_end: End address, useful for ignoring config bytes * @addr_end: End address, useful for ignoring config bytes
* @flags: some #FwupdInstallFlags, e.g. %FWUPD_INSTALL_FLAG_FORCE * @flags: some #FwupdInstallFlags, e.g. %FWUPD_INSTALL_FLAG_FORCE
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Parses a firmware, typically breaking the firmware into images. * Parses a firmware, typically breaking the firmware into images.
* *
@ -717,7 +717,7 @@ fu_firmware_parse_full (FuFirmware *self,
* @self: A #FuFirmware * @self: A #FuFirmware
* @fw: A #GBytes * @fw: A #GBytes
* @flags: some #FwupdInstallFlags, e.g. %FWUPD_INSTALL_FLAG_FORCE * @flags: some #FwupdInstallFlags, e.g. %FWUPD_INSTALL_FLAG_FORCE
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Parses a firmware, typically breaking the firmware into images. * Parses a firmware, typically breaking the firmware into images.
* *
@ -735,7 +735,7 @@ fu_firmware_parse (FuFirmware *self, GBytes *fw, FwupdInstallFlags flags, GError
* fu_firmware_build: * fu_firmware_build:
* @self: A #FuFirmware * @self: A #FuFirmware
* @n: A #XbNode * @n: A #XbNode
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Builds a firmware from an XML manifest. The manifest would typically have the * Builds a firmware from an XML manifest. The manifest would typically have the
* following form: * following form:
@ -904,7 +904,7 @@ fu_firmware_build (FuFirmware *self, XbNode *n, GError **error)
* fu_firmware_build_from_xml: * fu_firmware_build_from_xml:
* @self: A #FuFirmware * @self: A #FuFirmware
* @xml: XML text * @xml: XML text
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Builds a firmware from an XML manifest. The manifest would typically have the * Builds a firmware from an XML manifest. The manifest would typically have the
* following form: * following form:
@ -983,7 +983,7 @@ fu_firmware_build_from_xml (FuFirmware *self, const gchar *xml, GError **error)
* @self: A #FuFirmware * @self: A #FuFirmware
* @file: A #GFile * @file: A #GFile
* @flags: some #FwupdInstallFlags, e.g. %FWUPD_INSTALL_FLAG_FORCE * @flags: some #FwupdInstallFlags, e.g. %FWUPD_INSTALL_FLAG_FORCE
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Parses a firmware file, typically breaking the firmware into images. * Parses a firmware file, typically breaking the firmware into images.
* *
@ -1011,7 +1011,7 @@ fu_firmware_parse_file (FuFirmware *self, GFile *file, FwupdInstallFlags flags,
/** /**
* fu_firmware_write: * fu_firmware_write:
* @self: A #FuFirmware * @self: A #FuFirmware
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Writes a firmware, typically packing the images into a binary blob. * Writes a firmware, typically packing the images into a binary blob.
* *
@ -1049,7 +1049,7 @@ fu_firmware_write (FuFirmware *self, GError **error)
* @self: a #FuFirmware * @self: a #FuFirmware
* @address: an address smaller than fu_firmware_get_addr() * @address: an address smaller than fu_firmware_get_addr()
* @chunk_sz_max: the size of the new chunk * @chunk_sz_max: the size of the new chunk
* @error: a #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets a block of data from the image. If the contents of the image is * Gets a block of data from the image. If the contents of the image is
* smaller than the requested chunk size then the #GBytes will be smaller * smaller than the requested chunk size then the #GBytes will be smaller
@ -1057,7 +1057,7 @@ fu_firmware_write (FuFirmware *self, GError **error)
* *
* If the @address is larger than the size of the image then an error is returned. * If the @address is larger than the size of the image then an error is returned.
* *
* Return value: (transfer full): a #GBytes, or %NULL * Returns: (transfer full): a #GBytes, or %NULL
* *
* Since: 1.6.0 * Since: 1.6.0
**/ **/
@ -1116,7 +1116,7 @@ fu_firmware_write_chunk (FuFirmware *self,
* fu_firmware_write_file: * fu_firmware_write_file:
* @self: A #FuFirmware * @self: A #FuFirmware
* @file: A #GFile * @file: A #GFile
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Writes a firmware, typically packing the images into a binary blob. * Writes a firmware, typically packing the images into a binary blob.
* *
@ -1189,7 +1189,7 @@ fu_firmware_add_image (FuFirmware *self, FuFirmware *img)
* fu_firmware_remove_image: * fu_firmware_remove_image:
* @self: a #FuPlugin * @self: a #FuPlugin
* @img: A #FuFirmware * @img: A #FuFirmware
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Remove an image from the firmware. * Remove an image from the firmware.
* *
@ -1222,7 +1222,7 @@ fu_firmware_remove_image (FuFirmware *self, FuFirmware *img, GError **error)
* fu_firmware_remove_image_by_idx: * fu_firmware_remove_image_by_idx:
* @self: a #FuPlugin * @self: a #FuPlugin
* @idx: index * @idx: index
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Removes the first image from the firmware matching the index. * Removes the first image from the firmware matching the index.
* *
@ -1250,7 +1250,7 @@ fu_firmware_remove_image_by_idx (FuFirmware *self, guint64 idx, GError **error)
* fu_firmware_remove_image_by_id: * fu_firmware_remove_image_by_id:
* @self: a #FuPlugin * @self: a #FuPlugin
* @id: (nullable): image ID, e.g. "config" * @id: (nullable): image ID, e.g. "config"
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Removes the first image from the firmware matching the ID. * Removes the first image from the firmware matching the ID.
* *
@ -1304,7 +1304,7 @@ fu_firmware_get_images (FuFirmware *self)
* fu_firmware_get_image_by_id: * fu_firmware_get_image_by_id:
* @self: a #FuPlugin * @self: a #FuPlugin
* @id: (nullable): image ID, e.g. "config" * @id: (nullable): image ID, e.g. "config"
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the firmware image using the image ID. * Gets the firmware image using the image ID.
* *
@ -1336,7 +1336,7 @@ fu_firmware_get_image_by_id (FuFirmware *self, const gchar *id, GError **error)
* fu_firmware_get_image_by_id_bytes: * fu_firmware_get_image_by_id_bytes:
* @self: a #FuPlugin * @self: a #FuPlugin
* @id: (nullable): image ID, e.g. "config" * @id: (nullable): image ID, e.g. "config"
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the firmware image bytes using the image ID. * Gets the firmware image bytes using the image ID.
* *
@ -1357,7 +1357,7 @@ fu_firmware_get_image_by_id_bytes (FuFirmware *self, const gchar *id, GError **e
* fu_firmware_get_image_by_idx: * fu_firmware_get_image_by_idx:
* @self: a #FuPlugin * @self: a #FuPlugin
* @idx: image index * @idx: image index
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the firmware image using the image index. * Gets the firmware image using the image index.
* *
@ -1389,7 +1389,7 @@ fu_firmware_get_image_by_idx (FuFirmware *self, guint64 idx, GError **error)
* fu_firmware_get_image_by_checksum: * fu_firmware_get_image_by_checksum:
* @self: a #FuPlugin * @self: a #FuPlugin
* @checksum: checksum string of any format * @checksum: checksum string of any format
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the firmware image using the image checksum. The checksum type is guessed * Gets the firmware image using the image checksum. The checksum type is guessed
* based on the length of the input string. * based on the length of the input string.
@ -1434,7 +1434,7 @@ fu_firmware_get_image_by_checksum (FuFirmware *self,
* fu_firmware_get_image_by_idx_bytes: * fu_firmware_get_image_by_idx_bytes:
* @self: a #FuPlugin * @self: a #FuPlugin
* @idx: image index * @idx: image index
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the firmware image bytes using the image index. * Gets the firmware image bytes using the image index.
* *
@ -1539,7 +1539,7 @@ fu_firmware_export (FuFirmware *self,
* fu_firmware_export_to_xml: * fu_firmware_export_to_xml:
* @self: A #FuFirmware * @self: A #FuFirmware
* @flags: #FuFirmwareExportFlags, e.g. %FU_FIRMWARE_EXPORT_FLAG_INCLUDE_DEBUG * @flags: #FuFirmwareExportFlags, e.g. %FU_FIRMWARE_EXPORT_FLAG_INCLUDE_DEBUG
* @error: (nullable): a #GError or %NULL * @error: (nullable): optional return location for an error
* *
* This allows us to build an XML object for the nested firmware. * This allows us to build an XML object for the nested firmware.
* *
@ -1658,12 +1658,12 @@ fu_firmware_new_from_bytes (GBytes *fw)
* fu_firmware_new_from_gtypes: * fu_firmware_new_from_gtypes:
* @fw: a #GBytes * @fw: a #GBytes
* @flags: a #FwupdInstallFlags, e.g. %FWUPD_INSTALL_FLAG_IGNORE_CHECKSUM * @flags: a #FwupdInstallFlags, e.g. %FWUPD_INSTALL_FLAG_IGNORE_CHECKSUM
* @error: (nullable): a #GError or %NULL * @error: (nullable): optional return location for an error
* @...: An array of #GTypes, ending with %G_TYPE_INVALID * @...: An array of #GTypes, ending with %G_TYPE_INVALID
* *
* Tries to parse the firmware with each #GType in order. * Tries to parse the firmware with each #GType in order.
* *
* Return value: (transfer full) (nullable): A #FuFirmware, or %NULL * Returns: (transfer full) (nullable): A #FuFirmware, or %NULL
* *
* Since: 1.5.6 * Since: 1.5.6
**/ **/

4
libfwupdplugin/fu-hid-device.c
View File

@ -290,7 +290,7 @@ fu_hid_device_set_report_internal_cb (FuDevice *device, gpointer user_data, GErr
* @bufsz: Size of @buf * @bufsz: Size of @buf
* @timeout: timeout in ms * @timeout: timeout in ms
* @flags: #FuHidDeviceFlags e.g. %FU_HID_DEVICE_FLAG_ALLOW_TRUNC * @flags: #FuHidDeviceFlags e.g. %FU_HID_DEVICE_FLAG_ALLOW_TRUNC
* @error: a #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Calls SetReport on the hardware. * Calls SetReport on the hardware.
* *
@ -403,7 +403,7 @@ fu_hid_device_get_report_internal_cb (FuDevice *device, gpointer user_data, GErr
* @bufsz: Size of @buf * @bufsz: Size of @buf
* @timeout: timeout in ms * @timeout: timeout in ms
* @flags: #FuHidDeviceFlags e.g. %FU_HID_DEVICE_FLAG_ALLOW_TRUNC * @flags: #FuHidDeviceFlags e.g. %FU_HID_DEVICE_FLAG_ALLOW_TRUNC
* @error: a #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Calls GetReport on the hardware. * Calls GetReport on the hardware.
* *

10
libfwupdplugin/fu-hwids.c
View File

@ -234,7 +234,7 @@ fu_hwids_get_replace_keys (FuHwids *self, const gchar *key)
* fu_hwids_add_smbios_override: * fu_hwids_add_smbios_override:
* @self: A #FuHwids * @self: A #FuHwids
* @key: A key, e.g. %FU_HWIDS_KEY_PRODUCT_SKU * @key: A key, e.g. %FU_HWIDS_KEY_PRODUCT_SKU
* @value: (nullable): A new value, e.g. "ExampleModel" or %NULL * @value: (nullable): A new value, e.g. "ExampleModel"
* *
* Sets SMBIOS override values so you can emulate another system. * Sets SMBIOS override values so you can emulate another system.
* *
@ -254,7 +254,7 @@ fu_hwids_add_smbios_override (FuHwids *self, const gchar *key, const gchar *valu
* fu_hwids_get_replace_values: * fu_hwids_get_replace_values:
* @self: A #FuHwids * @self: A #FuHwids
* @keys: A key, e.g. `HardwareID-3` or %FU_HWIDS_KEY_PRODUCT_SKU * @keys: A key, e.g. `HardwareID-3` or %FU_HWIDS_KEY_PRODUCT_SKU
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the replacement values for a HardwareID key or plain key. * Gets the replacement values for a HardwareID key or plain key.
* *
@ -298,7 +298,7 @@ fu_hwids_get_replace_values (FuHwids *self, const gchar *keys, GError **error)
* fu_hwids_get_guid: * fu_hwids_get_guid:
* @self: A #FuHwids * @self: A #FuHwids
* @keys: A key, e.g. `HardwareID-3` or %FU_HWIDS_KEY_PRODUCT_SKU * @keys: A key, e.g. `HardwareID-3` or %FU_HWIDS_KEY_PRODUCT_SKU
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the GUID for a specific key. * Gets the GUID for a specific key.
* *
@ -364,8 +364,8 @@ fu_hwids_convert_integer_cb (FuSmbios *smbios,
/** /**
* fu_hwids_setup: * fu_hwids_setup:
* @self: A #FuHwids * @self: A #FuHwids
* @smbios: (nullable): A #FuSmbios or %NULL * @smbios: (nullable): A #FuSmbios
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Reads all the SMBIOS values from the hardware. * Reads all the SMBIOS values from the hardware.
* *

20
libfwupdplugin/fu-io-channel.c
View File

@ -49,7 +49,7 @@ fu_io_channel_unix_get_fd (FuIOChannel *self)
/** /**
* fu_io_channel_shutdown: * fu_io_channel_shutdown:
* @self: a #FuIOChannel * @self: a #FuIOChannel
* @error: a #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Closes the file descriptor for the device. * Closes the file descriptor for the device.
* *
@ -90,7 +90,7 @@ fu_io_channel_flush_input (FuIOChannel *self, GError **error)
* @bytes: buffer to write * @bytes: buffer to write
* @timeout_ms: timeout in ms * @timeout_ms: timeout in ms
* @flags: some #FuIOChannelFlags, e.g. %FU_IO_CHANNEL_FLAG_SINGLE_SHOT * @flags: some #FuIOChannelFlags, e.g. %FU_IO_CHANNEL_FLAG_SINGLE_SHOT
* @error: a #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Writes bytes to the TTY, that will fail if exceeding @timeout_ms. * Writes bytes to the TTY, that will fail if exceeding @timeout_ms.
* *
@ -116,7 +116,7 @@ fu_io_channel_write_bytes (FuIOChannel *self,
* @buf: buffer to write * @buf: buffer to write
* @timeout_ms: timeout in ms * @timeout_ms: timeout in ms
* @flags: some #FuIOChannelFlags, e.g. %FU_IO_CHANNEL_FLAG_SINGLE_SHOT * @flags: some #FuIOChannelFlags, e.g. %FU_IO_CHANNEL_FLAG_SINGLE_SHOT
* @error: a #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Writes bytes to the TTY, that will fail if exceeding @timeout_ms. * Writes bytes to the TTY, that will fail if exceeding @timeout_ms.
* *
@ -141,7 +141,7 @@ fu_io_channel_write_byte_array (FuIOChannel *self,
* @datasz: size of @data * @datasz: size of @data
* @timeout_ms: timeout in ms * @timeout_ms: timeout in ms
* @flags: some #FuIOChannelFlags, e.g. %FU_IO_CHANNEL_FLAG_SINGLE_SHOT * @flags: some #FuIOChannelFlags, e.g. %FU_IO_CHANNEL_FLAG_SINGLE_SHOT
* @error: a #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Writes bytes to the TTY, that will fail if exceeding @timeout_ms. * Writes bytes to the TTY, that will fail if exceeding @timeout_ms.
* *
@ -238,7 +238,7 @@ fu_io_channel_write_raw (FuIOChannel *self,
* @max_size: maximum size of the returned blob, or -1 for no limit * @max_size: maximum size of the returned blob, or -1 for no limit
* @timeout_ms: timeout in ms * @timeout_ms: timeout in ms
* @flags: some #FuIOChannelFlags, e.g. %FU_IO_CHANNEL_FLAG_SINGLE_SHOT * @flags: some #FuIOChannelFlags, e.g. %FU_IO_CHANNEL_FLAG_SINGLE_SHOT
* @error: a #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Reads bytes from the TTY, that will fail if exceeding @timeout_ms. * Reads bytes from the TTY, that will fail if exceeding @timeout_ms.
* *
@ -269,7 +269,7 @@ fu_io_channel_read_bytes (FuIOChannel *self,
* @max_size: maximum size of the returned blob, or -1 for no limit * @max_size: maximum size of the returned blob, or -1 for no limit
* @timeout_ms: timeout in ms * @timeout_ms: timeout in ms
* @flags: some #FuIOChannelFlags, e.g. %FU_IO_CHANNEL_FLAG_SINGLE_SHOT * @flags: some #FuIOChannelFlags, e.g. %FU_IO_CHANNEL_FLAG_SINGLE_SHOT
* @error: a #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Reads bytes from the TTY, that will fail if exceeding @timeout_ms. * Reads bytes from the TTY, that will fail if exceeding @timeout_ms.
* *
@ -396,12 +396,12 @@ fu_io_channel_read_byte_array (FuIOChannel *self,
/** /**
* fu_io_channel_read_raw: * fu_io_channel_read_raw:
* @self: a #FuIOChannel * @self: a #FuIOChannel
* @buf: buffer, or %NULL * @buf: (nullable): optional buffer
* @bufsz: size of @buf * @bufsz: size of @buf
* @bytes_read: (out): data written to @buf, or %NULL * @bytes_read: (out) (nullable): data written to @buf
* @timeout_ms: timeout in ms * @timeout_ms: timeout in ms
* @flags: some #FuIOChannelFlags, e.g. %FU_IO_CHANNEL_FLAG_SINGLE_SHOT * @flags: some #FuIOChannelFlags, e.g. %FU_IO_CHANNEL_FLAG_SINGLE_SHOT
* @error: a #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Reads bytes from the TTY, that will fail if exceeding @timeout_ms. * Reads bytes from the TTY, that will fail if exceeding @timeout_ms.
* *
@ -479,7 +479,7 @@ fu_io_channel_unix_new (gint fd)
/** /**
* fu_io_channel_new_file: * fu_io_channel_new_file:
* @filename: device file * @filename: device file
* @error: a #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Creates a new object to write and read from. * Creates a new object to write and read from.
* *

32
libfwupdplugin/fu-plugin-vfuncs.h
View File

@ -108,7 +108,7 @@ gboolean fu_plugin_coldplug_cleanup (FuPlugin *plugin,
* @dev: A #FuDevice * @dev: A #FuDevice
* @blob_fw: A #GBytes * @blob_fw: A #GBytes
* @flags: A #FwupdInstallFlags * @flags: A #FwupdInstallFlags
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Updates the firmware on the device with blob_fw * Updates the firmware on the device with blob_fw
* *
@ -124,7 +124,7 @@ gboolean fu_plugin_update (FuPlugin *plugin,
* @plugin: A #FuPlugin * @plugin: A #FuPlugin
* @dev: A #FuDevice * @dev: A #FuDevice
* @flags: A #FuPluginVerifyFlags * @flags: A #FuPluginVerifyFlags
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Verifies the firmware on the device matches the value stored in the database * Verifies the firmware on the device matches the value stored in the database
* *
@ -138,7 +138,7 @@ gboolean fu_plugin_verify (FuPlugin *plugin,
* fu_plugin_unlock: * fu_plugin_unlock:
* @plugin: A #FuPlugin * @plugin: A #FuPlugin
* @dev: A #FuDevice * @dev: A #FuDevice
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Unlocks the device for writes. * Unlocks the device for writes.
* *
@ -151,7 +151,7 @@ gboolean fu_plugin_unlock (FuPlugin *plugin,
* fu_plugin_activate: * fu_plugin_activate:
* @plugin: A #FuPlugin * @plugin: A #FuPlugin
* @dev: A #FuDevice * @dev: A #FuDevice
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Activates the new firmware on the device. * Activates the new firmware on the device.
* *
@ -167,7 +167,7 @@ gboolean fu_plugin_activate (FuPlugin *plugin,
* fu_plugin_clear_results: * fu_plugin_clear_results:
* @plugin: A #FuPlugin * @plugin: A #FuPlugin
* @dev: A #FuDevice * @dev: A #FuDevice
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Clears stored update results for the device. * Clears stored update results for the device.
* *
@ -180,7 +180,7 @@ gboolean fu_plugin_clear_results (FuPlugin *plugin,
* fu_plugin_get_results: * fu_plugin_get_results:
* @plugin: A #FuPlugin * @plugin: A #FuPlugin
* @dev: A #FuDevice * @dev: A #FuDevice
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Obtains historical update results for the device. * Obtains historical update results for the device.
* *
@ -193,7 +193,7 @@ gboolean fu_plugin_get_results (FuPlugin *plugin,
* fu_plugin_update_attach: * fu_plugin_update_attach:
* @plugin: A #FuPlugin * @plugin: A #FuPlugin
* @dev: A #FuDevice * @dev: A #FuDevice
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Swaps the device from bootloader mode to runtime mode. * Swaps the device from bootloader mode to runtime mode.
* *
@ -206,7 +206,7 @@ gboolean fu_plugin_update_attach (FuPlugin *plugin,
* fu_plugin_update_detach: * fu_plugin_update_detach:
* @plugin: A #FuPlugin * @plugin: A #FuPlugin
* @dev: A #FuDevice * @dev: A #FuDevice
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Swaps the device from runtime mode to bootloader mode. * Swaps the device from runtime mode to bootloader mode.
* *
@ -220,7 +220,7 @@ gboolean fu_plugin_update_detach (FuPlugin *plugin,
* @plugin: A #FuPlugin * @plugin: A #FuPlugin
* @flags: A #FwupdInstallFlags * @flags: A #FwupdInstallFlags
* @dev: A #FuDevice * @dev: A #FuDevice
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Prepares the device to receive an update. * Prepares the device to receive an update.
* *
@ -235,7 +235,7 @@ gboolean fu_plugin_update_prepare (FuPlugin *plugin,
* @plugin: A #FuPlugin * @plugin: A #FuPlugin
* @flags: A #FwupdInstallFlags * @flags: A #FwupdInstallFlags
* @dev: A #FuDevice * @dev: A #FuDevice
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Cleans up the device after receiving an update. * Cleans up the device after receiving an update.
* *
@ -249,7 +249,7 @@ gboolean fu_plugin_update_cleanup (FuPlugin *plugin,
* fu_plugin_composite_prepare * fu_plugin_composite_prepare
* @plugin: A #FuPlugin * @plugin: A #FuPlugin
* @devices: A #GPtrArray of #FuDevice * @devices: A #GPtrArray of #FuDevice
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Function run before updating group of composite devices. * Function run before updating group of composite devices.
* *
@ -262,7 +262,7 @@ gboolean fu_plugin_composite_prepare (FuPlugin *plugin,
* fu_plugin_composite_cleanup * fu_plugin_composite_cleanup
* @plugin: A #FuPlugin * @plugin: A #FuPlugin
* @devices: A #GPtrArray of #FuDevice * @devices: A #GPtrArray of #FuDevice
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Function run after updating group of composite devices. * Function run after updating group of composite devices.
* *
@ -275,7 +275,7 @@ gboolean fu_plugin_composite_cleanup (FuPlugin *plugin,
* fu_plugin_backend_device_added * fu_plugin_backend_device_added
* @plugin: A #FuPlugin * @plugin: A #FuPlugin
* @device: A #FuDevice * @device: A #FuDevice
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Function to run after a device is added by a backend, e.g. by USB or Udev. * Function to run after a device is added by a backend, e.g. by USB or Udev.
* *
@ -288,7 +288,7 @@ gboolean fu_plugin_backend_device_added (FuPlugin *plugin,
* fu_plugin_backend_device_changed * fu_plugin_backend_device_changed
* @plugin: A #FuPlugin * @plugin: A #FuPlugin
* @device: A #FuDevice * @device: A #FuDevice
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Function run when the device changed. * Function run when the device changed.
* *
@ -301,7 +301,7 @@ gboolean fu_plugin_backend_device_changed (FuPlugin *plugin,
* fu_plugin_backend_device_removed * fu_plugin_backend_device_removed
* @plugin: A #FuPlugin * @plugin: A #FuPlugin
* @device: A #FuDevice * @device: A #FuDevice
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Function to run when device is physically removed. * Function to run when device is physically removed.
* *
@ -325,7 +325,7 @@ void fu_plugin_device_added (FuPlugin *plugin,
* fu_plugin_device_created * fu_plugin_device_created
* @plugin: A #FuPlugin * @plugin: A #FuPlugin
* @dev: A #FuDevice * @dev: A #FuDevice
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Function run when the subclassed device has been created. * Function run when the subclassed device has been created.
* *

14
libfwupdplugin/fu-plugin.c
View File

@ -326,7 +326,7 @@ fu_plugin_guess_name_from_fn (const gchar *filename)
* fu_plugin_open: * fu_plugin_open:
* @self: A #FuPlugin * @self: A #FuPlugin
* @filename: The shared object filename to open * @filename: The shared object filename to open
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Opens the plugin module * Opens the plugin module
* *
@ -1606,7 +1606,7 @@ fu_plugin_runner_device_created (FuPlugin *self, FuDevice *device, GError **erro
* @self: a #FuPlugin * @self: a #FuPlugin
* @device: a #FuDevice * @device: a #FuDevice
* @flags: #FuPluginVerifyFlags * @flags: #FuPluginVerifyFlags
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Call into the plugin's verify routine * Call into the plugin's verify routine
* *
@ -1703,7 +1703,7 @@ fu_plugin_runner_verify (FuPlugin *self,
* fu_plugin_runner_activate: * fu_plugin_runner_activate:
* @self: a #FuPlugin * @self: a #FuPlugin
* @device: a #FuDevice * @device: a #FuDevice
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Call into the plugin's activate routine * Call into the plugin's activate routine
* *
@ -1748,7 +1748,7 @@ fu_plugin_runner_activate (FuPlugin *self, FuDevice *device, GError **error)
* fu_plugin_runner_unlock: * fu_plugin_runner_unlock:
* @self: a #FuPlugin * @self: a #FuPlugin
* @device: a #FuDevice * @device: a #FuDevice
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Call into the plugin's unlock routine * Call into the plugin's unlock routine
* *
@ -1795,7 +1795,7 @@ fu_plugin_runner_unlock (FuPlugin *self, FuDevice *device, GError **error)
* @device: a #FuDevice * @device: a #FuDevice
* @blob_fw: A #GBytes * @blob_fw: A #GBytes
* @flags: A #FwupdInstallFlags * @flags: A #FwupdInstallFlags
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Call into the plugin's update routine * Call into the plugin's update routine
* *
@ -1868,7 +1868,7 @@ fu_plugin_runner_update (FuPlugin *self,
* fu_plugin_runner_clear_results: * fu_plugin_runner_clear_results:
* @self: a #FuPlugin * @self: a #FuPlugin
* @device: a #FuDevice * @device: a #FuDevice
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Call into the plugin's clear results routine * Call into the plugin's clear results routine
* *
@ -1921,7 +1921,7 @@ fu_plugin_runner_clear_results (FuPlugin *self, FuDevice *device, GError **error
* fu_plugin_runner_get_results: * fu_plugin_runner_get_results:
* @self: a #FuPlugin * @self: a #FuPlugin
* @device: a #FuDevice * @device: a #FuDevice
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Call into the plugin's get results routine * Call into the plugin's get results routine
* *

4
libfwupdplugin/fu-quirks.c
View File

@ -450,7 +450,7 @@ fu_quirks_lookup_by_id_iter (FuQuirks *self, const gchar *group,
* fu_quirks_load: (skip) * fu_quirks_load: (skip)
* @self: A #FuQuirks * @self: A #FuQuirks
* @load_flags: A #FuQuirksLoadFlags * @load_flags: A #FuQuirksLoadFlags
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Loads the various files that define the hardware quirks used in plugins. * Loads the various files that define the hardware quirks used in plugins.
* *
@ -543,7 +543,7 @@ fu_quirks_finalize (GObject *obj)
* *
* Creates a new quirks object. * Creates a new quirks object.
* *
* Return value: a new #FuQuirks * Returns: a new #FuQuirks
* *
* Since: 1.0.1 * Since: 1.0.1
**/ **/

12
libfwupdplugin/fu-smbios.c
View File

@ -205,7 +205,7 @@ fu_smbios_setup_from_data (FuSmbios *self, const guint8 *buf, gsize sz, GError *
* fu_smbios_setup_from_file: * fu_smbios_setup_from_file:
* @self: A #FuSmbios * @self: A #FuSmbios
* @filename: A filename * @filename: A filename
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Reads all the SMBIOS values from a DMI blob. * Reads all the SMBIOS values from a DMI blob.
* *
@ -412,7 +412,7 @@ fu_smbios_parse (FuFirmware *firmware,
* fu_smbios_setup_from_path: * fu_smbios_setup_from_path:
* @self: A #FuSmbios * @self: A #FuSmbios
* @path: A path, e.g. `/sys/firmware/dmi/tables` * @path: A path, e.g. `/sys/firmware/dmi/tables`
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Reads all the SMBIOS values from a specific path. * Reads all the SMBIOS values from a specific path.
* *
@ -439,7 +439,7 @@ fu_smbios_setup_from_path (FuSmbios *self, const gchar *path, GError **error)
/** /**
* fu_smbios_setup: * fu_smbios_setup:
* @self: A #FuSmbios * @self: A #FuSmbios
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Reads all the SMBIOS values from the hardware. * Reads all the SMBIOS values from the hardware.
* *
@ -533,7 +533,7 @@ fu_smbios_get_item_for_type (FuSmbios *self, guint8 type)
* fu_smbios_get_data: * fu_smbios_get_data:
* @self: A #FuSmbios * @self: A #FuSmbios
* @type: A structure type, e.g. %FU_SMBIOS_STRUCTURE_TYPE_BIOS * @type: A structure type, e.g. %FU_SMBIOS_STRUCTURE_TYPE_BIOS
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Reads a SMBIOS data blob, which includes the SMBIOS section header. * Reads a SMBIOS data blob, which includes the SMBIOS section header.
* *
@ -565,7 +565,7 @@ fu_smbios_get_data (FuSmbios *self, guint8 type, GError **error)
* @self: A #FuSmbios * @self: A #FuSmbios
* @type: A structure type, e.g. %FU_SMBIOS_STRUCTURE_TYPE_BIOS * @type: A structure type, e.g. %FU_SMBIOS_STRUCTURE_TYPE_BIOS
* @offset: A structure offset * @offset: A structure offset
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Reads an integer value from the SMBIOS string table of a specific structure. * Reads an integer value from the SMBIOS string table of a specific structure.
* *
@ -613,7 +613,7 @@ fu_smbios_get_integer (FuSmbios *self, guint8 type, guint8 offset, GError **erro
* @self: A #FuSmbios * @self: A #FuSmbios
* @type: A structure type, e.g. %FU_SMBIOS_STRUCTURE_TYPE_BIOS * @type: A structure type, e.g. %FU_SMBIOS_STRUCTURE_TYPE_BIOS
* @offset: A structure offset * @offset: A structure offset
* @error: A #GError or %NULL * @error: (nullable): optional return location for an error
* *
* Reads a string from the SMBIOS string table of a specific structure. * Reads a string from the SMBIOS string table of a specific structure.
* *

18
libfwupdplugin/fu-udev-device.c
View File

@ -975,7 +975,7 @@ fu_udev_device_get_parent_subsystems (FuUdevDevice *self)
* fu_udev_device_set_physical_id: * fu_udev_device_set_physical_id:
* @self: A #FuUdevDevice * @self: A #FuUdevDevice
* @subsystems: A subsystem string, e.g. `pci,usb` * @subsystems: A subsystem string, e.g. `pci,usb`
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Sets the physical ID from the device subsystem. Plugins should choose the * Sets the physical ID from the device subsystem. Plugins should choose the
* subsystem that is "deepest" in the udev tree, for instance choosing 'usb' * subsystem that is "deepest" in the udev tree, for instance choosing 'usb'
@ -1097,7 +1097,7 @@ fu_udev_device_set_physical_id (FuUdevDevice *self, const gchar *subsystems, GEr
* fu_udev_device_set_logical_id: * fu_udev_device_set_logical_id:
* @self: A #FuUdevDevice * @self: A #FuUdevDevice
* @subsystem: A subsystem string, e.g. `pci,usb` * @subsystem: A subsystem string, e.g. `pci,usb`
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Sets the logical ID from the device subsystem. Plugins should choose the * Sets the logical ID from the device subsystem. Plugins should choose the
* subsystem that most relevant in the udev tree, for instance choosing 'hid' * subsystem that most relevant in the udev tree, for instance choosing 'hid'
@ -1354,7 +1354,7 @@ fu_udev_device_close (FuDevice *device, GError **error)
* @request: request number * @request: request number
* @buf: A buffer to use, which *must* be large enough for the request * @buf: A buffer to use, which *must* be large enough for the request
* @rc: (out) (nullable): the raw return value from the ioctl * @rc: (out) (nullable): the raw return value from the ioctl
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Control a device using a low-level request. * Control a device using a low-level request.
* *
@ -1430,7 +1430,7 @@ fu_udev_device_ioctl (FuUdevDevice *self,
* @port: offset address * @port: offset address
* @buf: (in): data * @buf: (in): data
* @bufsz: size of @buf * @bufsz: size of @buf
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Read a buffer from a file descriptor at a given offset. * Read a buffer from a file descriptor at a given offset.
* *
@ -1486,7 +1486,7 @@ fu_udev_device_pread_full (FuUdevDevice *self, goffset port,
* @port: offset address * @port: offset address
* @buf: (out): data * @buf: (out): data
* @bufsz: size of @data * @bufsz: size of @data
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Write a buffer to a file descriptor at a given offset. * Write a buffer to a file descriptor at a given offset.
* *
@ -1540,7 +1540,7 @@ fu_udev_device_pwrite_full (FuUdevDevice *self, goffset port,
* @self: A #FuUdevDevice * @self: A #FuUdevDevice
* @port: offset address * @port: offset address
* @data: value * @data: value
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Write to a file descriptor at a given offset. * Write to a file descriptor at a given offset.
* *
@ -1584,7 +1584,7 @@ fu_udev_device_get_parent_name (FuUdevDevice *self)
* fu_udev_device_get_sysfs_attr: * fu_udev_device_get_sysfs_attr:
* @self: A #FuUdevDevice * @self: A #FuUdevDevice
* @attr: name of attribute to get * @attr: name of attribute to get
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Reads an arbitrary sysfs attribute 'attr' associated with UDEV device * Reads an arbitrary sysfs attribute 'attr' associated with UDEV device
* *
@ -1637,7 +1637,7 @@ fu_udev_device_get_sysfs_attr (FuUdevDevice *self, const gchar *attr,
* @self: A #FuUdevDevice * @self: A #FuUdevDevice
* @port: offset address * @port: offset address
* @data: (out): value * @data: (out): value
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Read from a file descriptor at a given offset. * Read from a file descriptor at a given offset.
* *
@ -1657,7 +1657,7 @@ fu_udev_device_pread (FuUdevDevice *self, goffset port, guint8 *data, GError **e
* @self: A #FuUdevDevice * @self: A #FuUdevDevice
* @attribute: sysfs attribute name * @attribute: sysfs attribute name
* @val: data to write into the attribute * @val: data to write into the attribute
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Writes data into a sysfs attribute * Writes data into a sysfs attribute
* *

6
libfwupdplugin/fu-usb-device.c
View File

@ -437,7 +437,7 @@ fu_usb_device_get_platform_id (FuUsbDevice *self)
* *
* Gets the string USB revision for the device. * Gets the string USB revision for the device.
* *
* Return value: a specification revision in BCD format, or 0x0 if not supported * Returns: a specification revision in BCD format, or 0x0 if not supported
* *
* Since: 1.3.4 * Since: 1.3.4
**/ **/
@ -458,7 +458,7 @@ fu_usb_device_get_spec (FuUsbDevice *self)
/** /**
* fu_usb_device_set_dev: * fu_usb_device_set_dev:
* @device: A #FuUsbDevice * @device: A #FuUsbDevice
* @usb_device: A #GUsbDevice, or %NULL * @usb_device(nullable): optional #GUsbDevice
* *
* Sets the #GUsbDevice to use. * Sets the #GUsbDevice to use.
* *
@ -491,7 +491,7 @@ fu_usb_device_set_dev (FuUsbDevice *device, GUsbDevice *usb_device)
/** /**
* fu_usb_device_find_udev_device: * fu_usb_device_find_udev_device:
* @device: A #FuUsbDevice * @device: A #FuUsbDevice
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the matching #GUdevDevice for the #GUsbDevice. * Gets the matching #GUdevDevice for the #GUsbDevice.
* *

8
libfwupdplugin/fu-volume.c
View File

@ -183,7 +183,7 @@ fu_volume_get_mount_point (FuVolume *self)
* fu_volume_check_free_space: * fu_volume_check_free_space:
* @self: a @FuVolume * @self: a @FuVolume
* @required: size in bytes * @required: size in bytes
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Checks the volume for required space. * Checks the volume for required space.
* *
@ -276,7 +276,7 @@ fu_volume_is_encrypted (FuVolume *self)
/** /**
* fu_volume_mount: * fu_volume_mount:
* @self: a @FuVolume * @self: a @FuVolume
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Mounts the VOLUME ready for use. * Mounts the VOLUME ready for use.
* *
@ -359,7 +359,7 @@ fu_volume_get_id_type (FuVolume *self)
/** /**
* fu_volume_unmount: * fu_volume_unmount:
* @self: a @FuVolume * @self: a @FuVolume
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Unmounts the volume after use. * Unmounts the volume after use.
* *
@ -397,7 +397,7 @@ fu_volume_unmount (FuVolume *self, GError **error)
/** /**
* fu_volume_locker: * fu_volume_locker:
* @self: a @FuVolume * @self: a @FuVolume
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Locks the volume, mounting it and unmounting it as required. If the volume is * Locks the volume, mounting it and unmounting it as required. If the volume is
* already mounted then it is is _not_ unmounted when the locker is closed. * already mounted then it is is _not_ unmounted when the locker is closed.

2
plugins/dell-dock/fu-dell-dock-i2c-mst.c
View File

@ -115,7 +115,7 @@ G_DEFINE_TYPE (FuDellDockMst, fu_dell_dock_mst, FU_TYPE_DEVICE)
* fu_dell_dock_mst_get_bank_attribs: * fu_dell_dock_mst_get_bank_attribs:
* @bank: An MSTBank * @bank: An MSTBank
* @out (out): The MSTBankAttributes attribute that matches * @out (out): The MSTBankAttributes attribute that matches
* @error: the #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Returns a structure that corresponds to the attributes for a bank * Returns a structure that corresponds to the attributes for a bank
* *

6
plugins/dfu/fu-dfu-common.c
View File

@ -23,7 +23,7 @@
* *
* Converts an enumerated value to a string. * Converts an enumerated value to a string.
* *
* Return value: a string * Returns: a string
**/ **/
const gchar * const gchar *
fu_dfu_state_to_string (FuDfuState state) fu_dfu_state_to_string (FuDfuState state)
@ -59,7 +59,7 @@ fu_dfu_state_to_string (FuDfuState state)
* *
* Converts an enumerated value to a string. * Converts an enumerated value to a string.
* *
* Return value: a string * Returns: a string
**/ **/
const gchar * const gchar *
fu_dfu_status_to_string (FuDfuStatus status) fu_dfu_status_to_string (FuDfuStatus status)
@ -105,7 +105,7 @@ fu_dfu_status_to_string (FuDfuStatus status)
* *
* Creates a monolithic block of memory from an array of #GBytes. * Creates a monolithic block of memory from an array of #GBytes.
* *
* Return value: (transfer full): a new GBytes * Returns: (transfer full): a new GBytes
**/ **/
GBytes * GBytes *
fu_dfu_utils_bytes_join_array (GPtrArray *chunks) fu_dfu_utils_bytes_join_array (GPtrArray *chunks)

72
plugins/dfu/fu-dfu-device.c
View File

@ -148,7 +148,7 @@ fu_dfu_device_to_string (FuDevice *device, guint idt, GString *str)
* *
* Gets the transfer size in bytes. * Gets the transfer size in bytes.
* *
* Return value: packet size, or 0 for unknown * Returns: packet size, or 0 for unknown
**/ **/
guint16 guint16
fu_dfu_device_get_transfer_size (FuDfuDevice *self) fu_dfu_device_get_transfer_size (FuDfuDevice *self)
@ -164,7 +164,7 @@ fu_dfu_device_get_transfer_size (FuDfuDevice *self)
* *
* Gets the DFU specification version supported by the device. * Gets the DFU specification version supported by the device.
* *
* Return value: integer, or 0 for unknown, e.g. %DFU_VERSION_DFU_1_1 * Returns: integer, or 0 for unknown, e.g. %DFU_VERSION_DFU_1_1
**/ **/
guint16 guint16
fu_dfu_device_get_version (FuDfuDevice *self) fu_dfu_device_get_version (FuDfuDevice *self)
@ -180,7 +180,7 @@ fu_dfu_device_get_version (FuDfuDevice *self)
* *
* Gets the download timeout in ms. * Gets the download timeout in ms.
* *
* Return value: delay, or 0 for unknown * Returns: delay, or 0 for unknown
**/ **/
guint guint
fu_dfu_device_get_download_timeout (FuDfuDevice *self) fu_dfu_device_get_download_timeout (FuDfuDevice *self)
@ -436,7 +436,7 @@ fu_dfu_device_add_targets (FuDfuDevice *self, GError **error)
* *
* Gets if the device can upload. * Gets if the device can upload.
* *
* Return value: %TRUE if the device can upload from device to host * Returns: %TRUE if the device can upload from device to host
**/ **/
gboolean gboolean
fu_dfu_device_can_upload (FuDfuDevice *self) fu_dfu_device_can_upload (FuDfuDevice *self)
@ -452,7 +452,7 @@ fu_dfu_device_can_upload (FuDfuDevice *self)
* *
* Gets if the device can download. * Gets if the device can download.
* *
* Return value: %TRUE if the device can download from host to device * Returns: %TRUE if the device can download from host to device
**/ **/
gboolean gboolean
fu_dfu_device_can_download (FuDfuDevice *self) fu_dfu_device_can_download (FuDfuDevice *self)
@ -483,7 +483,7 @@ fu_dfu_device_set_timeout (FuDfuDevice *self, guint timeout_ms)
* *
* Gets the device timeout. * Gets the device timeout.
* *
* Return value: enumerated timeout in ms * Returns: enumerated timeout in ms
**/ **/
guint guint
fu_dfu_device_get_timeout (FuDfuDevice *self) fu_dfu_device_get_timeout (FuDfuDevice *self)
@ -499,7 +499,7 @@ fu_dfu_device_get_timeout (FuDfuDevice *self)
* *
* Gets the device state. * Gets the device state.
* *
* Return value: enumerated state, e.g. %FU_DFU_STATE_DFU_UPLOAD_IDLE * Returns: enumerated state, e.g. %FU_DFU_STATE_DFU_UPLOAD_IDLE
**/ **/
FuDfuState FuDfuState
fu_dfu_device_get_state (FuDfuDevice *self) fu_dfu_device_get_state (FuDfuDevice *self)
@ -515,7 +515,7 @@ fu_dfu_device_get_state (FuDfuDevice *self)
* *
* Gets the device status. * Gets the device status.
* *
* Return value: enumerated status, e.g. %FU_DFU_STATUS_ERR_ADDRESS * Returns: enumerated status, e.g. %FU_DFU_STATUS_ERR_ADDRESS
**/ **/
FuDfuStatus FuDfuStatus
fu_dfu_device_get_status (FuDfuDevice *self) fu_dfu_device_get_status (FuDfuDevice *self)
@ -532,7 +532,7 @@ fu_dfu_device_get_status (FuDfuDevice *self)
* *
* Returns if an attribute set for the device. * Returns if an attribute set for the device.
* *
* Return value: %TRUE if the attribute is set * Returns: %TRUE if the attribute is set
**/ **/
gboolean gboolean
fu_dfu_device_has_attribute (FuDfuDevice *self, FuDfuDeviceAttrs attribute) fu_dfu_device_has_attribute (FuDfuDevice *self, FuDfuDeviceAttrs attribute)
@ -562,7 +562,7 @@ fu_dfu_device_remove_attribute (FuDfuDevice *self, FuDfuDeviceAttrs attribute)
* *
* Creates a new DFU device object. * Creates a new DFU device object.
* *
* Return value: a new #FuDfuDevice * Returns: a new #FuDfuDevice
**/ **/
FuDfuDevice * FuDfuDevice *
fu_dfu_device_new (GUsbDevice *usb_device) fu_dfu_device_new (GUsbDevice *usb_device)
@ -580,7 +580,7 @@ fu_dfu_device_new (GUsbDevice *usb_device)
* *
* Gets all the targets for this device. * Gets all the targets for this device.
* *
* Return value: (transfer none) (element-type FuDfuTarget): #FuDfuTarget, or %NULL * Returns: (transfer none) (element-type FuDfuTarget): #FuDfuTarget, or %NULL
**/ **/
GPtrArray * GPtrArray *
fu_dfu_device_get_targets (FuDfuDevice *self) fu_dfu_device_get_targets (FuDfuDevice *self)
@ -594,11 +594,11 @@ fu_dfu_device_get_targets (FuDfuDevice *self)
* fu_dfu_device_get_target_by_alt_setting: * fu_dfu_device_get_target_by_alt_setting:
* @self: a #FuDfuDevice * @self: a #FuDfuDevice
* @alt_setting: the setting used to find * @alt_setting: the setting used to find
* @error: a #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets a target with a specific alternative setting. * Gets a target with a specific alternative setting.
* *
* Return value: (transfer full): a #FuDfuTarget, or %NULL * Returns: (transfer full): a #FuDfuTarget, or %NULL
**/ **/
FuDfuTarget * FuDfuTarget *
fu_dfu_device_get_target_by_alt_setting (FuDfuDevice *self, fu_dfu_device_get_target_by_alt_setting (FuDfuDevice *self,
@ -630,11 +630,11 @@ fu_dfu_device_get_target_by_alt_setting (FuDfuDevice *self,
* fu_dfu_device_get_target_by_alt_name: * fu_dfu_device_get_target_by_alt_name:
* @self: a #FuDfuDevice * @self: a #FuDfuDevice
* @alt_name: the name used to find * @alt_name: the name used to find
* @error: a #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets a target with a specific alternative name. * Gets a target with a specific alternative name.
* *
* Return value: (transfer full): a #FuDfuTarget, or %NULL * Returns: (transfer full): a #FuDfuTarget, or %NULL
**/ **/
FuDfuTarget * FuDfuTarget *
fu_dfu_device_get_target_by_alt_name (FuDfuDevice *self, fu_dfu_device_get_target_by_alt_name (FuDfuDevice *self,
@ -668,7 +668,7 @@ fu_dfu_device_get_target_by_alt_name (FuDfuDevice *self,
* *
* Gets the platform ID which normally corresponds to the port in some way. * Gets the platform ID which normally corresponds to the port in some way.
* *
* Return value: string or %NULL * Returns: string or %NULL
**/ **/
const gchar * const gchar *
fu_dfu_device_get_platform_id (FuDfuDevice *self) fu_dfu_device_get_platform_id (FuDfuDevice *self)
@ -684,7 +684,7 @@ fu_dfu_device_get_platform_id (FuDfuDevice *self)
* *
* Gets the runtime vendor ID. * Gets the runtime vendor ID.
* *
* Return value: vendor ID, or 0xffff for unknown * Returns: vendor ID, or 0xffff for unknown
**/ **/
guint16 guint16
fu_dfu_device_get_runtime_vid (FuDfuDevice *self) fu_dfu_device_get_runtime_vid (FuDfuDevice *self)
@ -700,7 +700,7 @@ fu_dfu_device_get_runtime_vid (FuDfuDevice *self)
* *
* Gets the runtime product ID. * Gets the runtime product ID.
* *
* Return value: product ID, or 0xffff for unknown * Returns: product ID, or 0xffff for unknown
**/ **/
guint16 guint16
fu_dfu_device_get_runtime_pid (FuDfuDevice *self) fu_dfu_device_get_runtime_pid (FuDfuDevice *self)
@ -716,7 +716,7 @@ fu_dfu_device_get_runtime_pid (FuDfuDevice *self)
* *
* Gets the runtime release number in BCD format. * Gets the runtime release number in BCD format.
* *
* Return value: release number, or 0xffff for unknown * Returns: release number, or 0xffff for unknown
**/ **/
guint16 guint16
fu_dfu_device_get_runtime_release (FuDfuDevice *self) fu_dfu_device_get_runtime_release (FuDfuDevice *self)
@ -805,13 +805,13 @@ fu_dfu_device_ensure_interface (FuDfuDevice *self, GError **error)
/** /**
* fu_dfu_device_refresh_and_clear: * fu_dfu_device_refresh_and_clear:
* @self: a #FuDfuDevice * @self: a #FuDfuDevice
* @error: a #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Refreshes the cached properties on the DFU device. If there are any transers * Refreshes the cached properties on the DFU device. If there are any transers
* in progress they are cancelled, and if there are any pending errors they are * in progress they are cancelled, and if there are any pending errors they are
* cancelled. * cancelled.
* *
* Return value: %TRUE for success * Returns: %TRUE for success
**/ **/
gboolean gboolean
fu_dfu_device_refresh_and_clear (FuDfuDevice *self, GError **error) fu_dfu_device_refresh_and_clear (FuDfuDevice *self, GError **error)
@ -841,11 +841,11 @@ fu_dfu_device_refresh_and_clear (FuDfuDevice *self, GError **error)
/** /**
* fu_dfu_device_refresh: * fu_dfu_device_refresh:
* @self: a #FuDfuDevice * @self: a #FuDfuDevice
* @error: a #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Refreshes the cached properties on the DFU device. * Refreshes the cached properties on the DFU device.
* *
* Return value: %TRUE for success * Returns: %TRUE for success
**/ **/
gboolean gboolean
fu_dfu_device_refresh (FuDfuDevice *self, GError **error) fu_dfu_device_refresh (FuDfuDevice *self, GError **error)
@ -1048,11 +1048,11 @@ fu_dfu_device_detach (FuDevice *device, GError **error)
/** /**
* fu_dfu_device_abort: * fu_dfu_device_abort:
* @self: a #FuDfuDevice * @self: a #FuDfuDevice
* @error: a #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Aborts any upload or download in progress. * Aborts any upload or download in progress.
* *
* Return value: %TRUE for success * Returns: %TRUE for success
**/ **/
gboolean gboolean
fu_dfu_device_abort (FuDfuDevice *self, GError **error) fu_dfu_device_abort (FuDfuDevice *self, GError **error)
@ -1115,11 +1115,11 @@ fu_dfu_device_abort (FuDfuDevice *self, GError **error)
/** /**
* fu_dfu_device_clear_status: * fu_dfu_device_clear_status:
* @self: a #FuDfuDevice * @self: a #FuDfuDevice
* @error: a #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Clears any error status on the DFU device. * Clears any error status on the DFU device.
* *
* Return value: %TRUE for success * Returns: %TRUE for success
**/ **/
gboolean gboolean
fu_dfu_device_clear_status (FuDfuDevice *self, GError **error) fu_dfu_device_clear_status (FuDfuDevice *self, GError **error)
@ -1195,11 +1195,11 @@ fu_dfu_device_get_interface (FuDfuDevice *self)
/** /**
* fu_dfu_device_open: * fu_dfu_device_open:
* @self: a #FuDfuDevice * @self: a #FuDfuDevice
* @error: a #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Opens a DFU-capable device. * Opens a DFU-capable device.
* *
* Return value: %TRUE for success * Returns: %TRUE for success
**/ **/
static gboolean static gboolean
fu_dfu_device_open (FuDevice *device, GError **error) fu_dfu_device_open (FuDevice *device, GError **error)
@ -1283,11 +1283,11 @@ fu_dfu_device_open (FuDevice *device, GError **error)
/** /**
* fu_dfu_device_close: * fu_dfu_device_close:
* @self: a #FuDfuDevice * @self: a #FuDfuDevice
* @error: a #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Closes a DFU device. * Closes a DFU device.
* *
* Return value: %TRUE for success * Returns: %TRUE for success
**/ **/
static gboolean static gboolean
fu_dfu_device_close (FuDevice *device, GError **error) fu_dfu_device_close (FuDevice *device, GError **error)
@ -1353,11 +1353,11 @@ fu_dfu_device_probe (FuDevice *device, GError **error)
/** /**
* fu_dfu_device_reset: * fu_dfu_device_reset:
* @self: a #FuDfuDevice * @self: a #FuDfuDevice
* @error: a #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Resets the USB device. * Resets the USB device.
* *
* Return value: %TRUE for success * Returns: %TRUE for success
**/ **/
gboolean gboolean
fu_dfu_device_reset (FuDfuDevice *self, GError **error) fu_dfu_device_reset (FuDfuDevice *self, GError **error)
@ -1469,11 +1469,11 @@ fu_dfu_device_action_cb (FuDfuTarget *target, FwupdStatus action, FuDfuDevice *s
* fu_dfu_device_upload: * fu_dfu_device_upload:
* @self: a #FuDfuDevice * @self: a #FuDfuDevice
* @flags: flags to use, e.g. %DFU_TARGET_TRANSFER_FLAG_VERIFY * @flags: flags to use, e.g. %DFU_TARGET_TRANSFER_FLAG_VERIFY
* @error: a #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Uploads firmware from the target to the host. * Uploads firmware from the target to the host.
* *
* Return value: (transfer full): the uploaded firmware, or %NULL for error * Returns: (transfer full): the uploaded firmware, or %NULL for error
**/ **/
FuFirmware * FuFirmware *
fu_dfu_device_upload (FuDfuDevice *self, fu_dfu_device_upload (FuDfuDevice *self,
@ -1875,7 +1875,7 @@ fu_dfu_device_set_quirk_kv (FuDevice *device,
* *
* Gets a string describing the attributes for a device. * Gets a string describing the attributes for a device.
* *
* Return value: a string, possibly empty * Returns: a string, possibly empty
**/ **/
gchar * gchar *
fu_dfu_device_get_attributes_as_string (FuDfuDevice *self) fu_dfu_device_get_attributes_as_string (FuDfuDevice *self)

18
plugins/dfu/fu-dfu-sector.c
View File

@ -61,7 +61,7 @@ fu_dfu_sector_init (FuDfuSector *self)
* *
* Creates a new DFU sector object. * Creates a new DFU sector object.
* *
* Return value: a new #FuDfuSector * Returns: a new #FuDfuSector
**/ **/
FuDfuSector * FuDfuSector *
fu_dfu_sector_new (guint32 address, guint32 size, guint32 size_left, fu_dfu_sector_new (guint32 address, guint32 size, guint32 size_left,
@ -86,7 +86,7 @@ fu_dfu_sector_new (guint32 address, guint32 size, guint32 size_left,
* *
* Gets the alternate setting. * Gets the alternate setting.
* *
* Return value: integer, or 0x00 for unset * Returns: integer, or 0x00 for unset
**/ **/
guint32 guint32
fu_dfu_sector_get_address (FuDfuSector *self) fu_dfu_sector_get_address (FuDfuSector *self)
@ -102,7 +102,7 @@ fu_dfu_sector_get_address (FuDfuSector *self)
* *
* Gets the sector size. * Gets the sector size.
* *
* Return value: integer, or 0x00 for unset * Returns: integer, or 0x00 for unset
**/ **/
guint32 guint32
fu_dfu_sector_get_size (FuDfuSector *self) fu_dfu_sector_get_size (FuDfuSector *self)
@ -118,7 +118,7 @@ fu_dfu_sector_get_size (FuDfuSector *self)
* *
* Gets the size of the rest of the sector. * Gets the size of the rest of the sector.
* *
* Return value: integer, or 0x00 for unset * Returns: integer, or 0x00 for unset
**/ **/
guint32 guint32
fu_dfu_sector_get_size_left (FuDfuSector *self) fu_dfu_sector_get_size_left (FuDfuSector *self)
@ -134,7 +134,7 @@ fu_dfu_sector_get_size_left (FuDfuSector *self)
* *
* Gets the sector zone number. * Gets the sector zone number.
* *
* Return value: integer, or 0x00 for unset * Returns: integer, or 0x00 for unset
**/ **/
guint16 guint16
fu_dfu_sector_get_zone (FuDfuSector *self) fu_dfu_sector_get_zone (FuDfuSector *self)
@ -150,7 +150,7 @@ fu_dfu_sector_get_zone (FuDfuSector *self)
* *
* Gets the sector index number. * Gets the sector index number.
* *
* Return value: integer, or 0x00 for unset * Returns: integer, or 0x00 for unset
**/ **/
guint16 guint16
fu_dfu_sector_get_number (FuDfuSector *self) fu_dfu_sector_get_number (FuDfuSector *self)
@ -168,7 +168,7 @@ fu_dfu_sector_get_number (FuDfuSector *self)
* You can use this number to check if the segment is the 'same' as the last * You can use this number to check if the segment is the 'same' as the last
* written or read sector. * written or read sector.
* *
* Return value: integer ID, or 0x00 for unset * Returns: integer ID, or 0x00 for unset
**/ **/
guint32 guint32
fu_dfu_sector_get_id (FuDfuSector *self) fu_dfu_sector_get_id (FuDfuSector *self)
@ -185,7 +185,7 @@ fu_dfu_sector_get_id (FuDfuSector *self)
* *
* Finds out if the sector has the required capability. * Finds out if the sector has the required capability.
* *
* Return value: %TRUE if the sector has the capabilily * Returns: %TRUE if the sector has the capabilily
**/ **/
gboolean gboolean
fu_dfu_sector_has_cap (FuDfuSector *self, FuDfuSectorCap cap) fu_dfu_sector_has_cap (FuDfuSector *self, FuDfuSectorCap cap)
@ -214,7 +214,7 @@ fu_dfu_sector_cap_to_string (FuDfuSectorCap cap)
* *
* Returns a string representation of the object. * Returns a string representation of the object.
* *
* Return value: NULL terminated string, or %NULL for invalid * Returns: NULL terminated string, or %NULL for invalid
**/ **/
gchar * gchar *
fu_dfu_sector_to_string (FuDfuSector *self) fu_dfu_sector_to_string (FuDfuSector *self)

28
plugins/dfu/fu-dfu-target-avr.c
View File

@ -148,11 +148,11 @@ fu_dfu_target_avr_attach (FuDfuTarget *target, GError **error)
* fu_dfu_target_avr_select_memory_unit: * fu_dfu_target_avr_select_memory_unit:
* @target: a #FuDfuTarget * @target: a #FuDfuTarget
* @memory_unit: a unit, e.g. %DFU_AVR32_MEMORY_UNIT_FLASH * @memory_unit: a unit, e.g. %DFU_AVR32_MEMORY_UNIT_FLASH
* @error: a #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Selects the memory unit for the device. * Selects the memory unit for the device.
* *
* Return value: %TRUE for success * Returns: %TRUE for success
**/ **/
static gboolean static gboolean
fu_dfu_target_avr_select_memory_unit (FuDfuTarget *target, fu_dfu_target_avr_select_memory_unit (FuDfuTarget *target,
@ -187,11 +187,11 @@ fu_dfu_target_avr_select_memory_unit (FuDfuTarget *target,
* fu_dfu_target_avr_select_memory_page: * fu_dfu_target_avr_select_memory_page:
* @target: a #FuDfuTarget * @target: a #FuDfuTarget
* @memory_page: an address * @memory_page: an address
* @error: a #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Selects the memory page for the AVR device. * Selects the memory page for the AVR device.
* *
* Return value: %TRUE for success * Returns: %TRUE for success
**/ **/
static gboolean static gboolean
fu_dfu_target_avr_select_memory_page (FuDfuTarget *target, fu_dfu_target_avr_select_memory_page (FuDfuTarget *target,
@ -230,11 +230,11 @@ fu_dfu_target_avr_select_memory_page (FuDfuTarget *target,
* fu_dfu_target_avr32_select_memory_page: * fu_dfu_target_avr32_select_memory_page:
* @target: a #FuDfuTarget * @target: a #FuDfuTarget
* @memory_page: an address * @memory_page: an address
* @error: a #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Selects the memory page for the AVR32 device. * Selects the memory page for the AVR32 device.
* *
* Return value: %TRUE for success * Returns: %TRUE for success
**/ **/
static gboolean static gboolean
fu_dfu_target_avr32_select_memory_page (FuDfuTarget *target, fu_dfu_target_avr32_select_memory_page (FuDfuTarget *target,
@ -263,11 +263,11 @@ fu_dfu_target_avr32_select_memory_page (FuDfuTarget *target,
* @target: a #FuDfuTarget * @target: a #FuDfuTarget
* @addr_start: an address * @addr_start: an address
* @addr_end: an address * @addr_end: an address
* @error: a #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Reads flash data from the device. * Reads flash data from the device.
* *
* Return value: %TRUE for success * Returns: %TRUE for success
**/ **/
static gboolean static gboolean
fu_dfu_target_avr_read_memory (FuDfuTarget *target, fu_dfu_target_avr_read_memory (FuDfuTarget *target,
@ -298,11 +298,11 @@ fu_dfu_target_avr_read_memory (FuDfuTarget *target,
* fu_dfu_target_avr_read_command: * fu_dfu_target_avr_read_command:
* @target: a #FuDfuTarget * @target: a #FuDfuTarget
* @memory_unit: a unit, e.g. %DFU_AVR32_MEMORY_UNIT_FLASH * @memory_unit: a unit, e.g. %DFU_AVR32_MEMORY_UNIT_FLASH
* @error: a #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Performs a read operation on the device. * Performs a read operation on the device.
* *
* Return value: %TRUE for success * Returns: %TRUE for success
**/ **/
static gboolean static gboolean
fu_dfu_target_avr_read_command (FuDfuTarget *target, guint8 page, guint8 addr, GError **error) fu_dfu_target_avr_read_command (FuDfuTarget *target, guint8 page, guint8 addr, GError **error)
@ -326,11 +326,11 @@ fu_dfu_target_avr_read_command (FuDfuTarget *target, guint8 page, guint8 addr, G
/** /**
* fu_dfu_target_avr32_get_chip_signature: * fu_dfu_target_avr32_get_chip_signature:
* @target: a #FuDfuTarget * @target: a #FuDfuTarget
* @error: a #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the chip signature for the AVR32 device. * Gets the chip signature for the AVR32 device.
* *
* Return value: a 4-byte %GBytes object for success, else %NULL * Returns: a 4-byte %GBytes object for success, else %NULL
**/ **/
static GBytes * static GBytes *
fu_dfu_target_avr32_get_chip_signature (FuDfuTarget *target, GError **error) fu_dfu_target_avr32_get_chip_signature (FuDfuTarget *target, GError **error)
@ -352,11 +352,11 @@ fu_dfu_target_avr32_get_chip_signature (FuDfuTarget *target, GError **error)
/** /**
* fu_dfu_target_avr_get_chip_signature: * fu_dfu_target_avr_get_chip_signature:
* @target: a #FuDfuTarget * @target: a #FuDfuTarget
* @error: a #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the chip signature for the AVR device. * Gets the chip signature for the AVR device.
* *
* Return value: a 4-byte %GBytes object for success, else %NULL * Returns: a 4-byte %GBytes object for success, else %NULL
**/ **/
static GBytes * static GBytes *
fu_dfu_target_avr_get_chip_signature (FuDfuTarget *target, GError **error) fu_dfu_target_avr_get_chip_signature (FuDfuTarget *target, GError **error)

8
plugins/dfu/fu-dfu-target-stm.c
View File

@ -59,11 +59,11 @@ fu_dfu_target_stm_mass_erase (FuDfuTarget *target, GError **error)
* fu_dfu_target_stm_set_address: * fu_dfu_target_stm_set_address:
* @target: a #FuDfuTarget * @target: a #FuDfuTarget
* @address: memory address * @address: memory address
* @error: a #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Sets the address used for the next download or upload request. * Sets the address used for the next download or upload request.
* *
* Return value: %TRUE for success * Returns: %TRUE for success
**/ **/
static gboolean static gboolean
fu_dfu_target_stm_set_address (FuDfuTarget *target, guint32 address, GError **error) fu_dfu_target_stm_set_address (FuDfuTarget *target, guint32 address, GError **error)
@ -215,11 +215,11 @@ fu_dfu_target_stm_upload_element (FuDfuTarget *target,
* fu_dfu_target_stm_erase_address: * fu_dfu_target_stm_erase_address:
* @target: a #FuDfuTarget * @target: a #FuDfuTarget
* @address: memory address * @address: memory address
* @error: a #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Erases a memory sector at a given address. * Erases a memory sector at a given address.
* *
* Return value: %TRUE for success * Returns: %TRUE for success
**/ **/
static gboolean static gboolean
fu_dfu_target_stm_erase_address (FuDfuTarget *target, guint32 address, GError **error) fu_dfu_target_stm_erase_address (FuDfuTarget *target, guint32 address, GError **error)

34
plugins/dfu/fu-dfu-target.c
View File

@ -388,7 +388,7 @@ fu_dfu_target_parse_sectors (FuDfuTarget *self, const gchar *alt_name, GError **
* Creates a new DFU target, which represents an alt-setting on a * Creates a new DFU target, which represents an alt-setting on a
* DFU-capable device. * DFU-capable device.
* *
* Return value: a #FuDfuTarget * Returns: a #FuDfuTarget
**/ **/
FuDfuTarget * FuDfuTarget *
fu_dfu_target_new (void) fu_dfu_target_new (void)
@ -404,7 +404,7 @@ fu_dfu_target_new (void)
* *
* Gets the sectors exported by the target. * Gets the sectors exported by the target.
* *
* Return value: (transfer none) (element-type FuDfuSector): sectors * Returns: (transfer none) (element-type FuDfuSector): sectors
**/ **/
GPtrArray * GPtrArray *
fu_dfu_target_get_sectors (FuDfuTarget *self) fu_dfu_target_get_sectors (FuDfuTarget *self)
@ -420,7 +420,7 @@ fu_dfu_target_get_sectors (FuDfuTarget *self)
* *
* Gets the default (first) sector exported by the target. * Gets the default (first) sector exported by the target.
* *
* Return value: (transfer none): a #FuDfuSector, or %NULL * Returns: (transfer none): a #FuDfuSector, or %NULL
**/ **/
FuDfuSector * FuDfuSector *
fu_dfu_target_get_sector_default (FuDfuTarget *self) fu_dfu_target_get_sector_default (FuDfuTarget *self)
@ -438,7 +438,7 @@ fu_dfu_target_get_sector_default (FuDfuTarget *self)
* *
* Converts an enumerated value to an error description. * Converts an enumerated value to an error description.
* *
* Return value: a string * Returns: a string
**/ **/
static const gchar * static const gchar *
fu_dfu_target_status_to_error_msg (FuDfuStatus status) fu_dfu_target_status_to_error_msg (FuDfuStatus status)
@ -580,11 +580,11 @@ fu_dfu_target_check_status (FuDfuTarget *self, GError **error)
/** /**
* fu_dfu_target_use_alt_setting: * fu_dfu_target_use_alt_setting:
* @self: a #FuDfuTarget * @self: a #FuDfuTarget
* @error: a #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Opens a DFU-capable target. * Opens a DFU-capable target.
* *
* Return value: %TRUE for success * Returns: %TRUE for success
**/ **/
static gboolean static gboolean
fu_dfu_target_use_alt_setting (FuDfuTarget *self, GError **error) fu_dfu_target_use_alt_setting (FuDfuTarget *self, GError **error)
@ -647,11 +647,11 @@ fu_dfu_target_set_device (FuDfuTarget *self, FuDfuDevice *device)
/** /**
* fu_dfu_target_setup: * fu_dfu_target_setup:
* @self: a #FuDfuTarget * @self: a #FuDfuTarget
* @error: a #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Opens a DFU-capable target. * Opens a DFU-capable target.
* *
* Return value: %TRUE for success * Returns: %TRUE for success
**/ **/
gboolean gboolean
fu_dfu_target_setup (FuDfuTarget *self, GError **error) fu_dfu_target_setup (FuDfuTarget *self, GError **error)
@ -748,13 +748,13 @@ fu_dfu_target_setup (FuDfuTarget *self, GError **error)
/** /**
* fu_dfu_target_mass_erase: * fu_dfu_target_mass_erase:
* @self: a #FuDfuTarget * @self: a #FuDfuTarget
* @error: a #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Mass erases the device clearing all SRAM and EEPROM memory. * Mass erases the device clearing all SRAM and EEPROM memory.
* *
* IMPORTANT: This only works on STM32 devices from ST and AVR32 devices from Atmel. * IMPORTANT: This only works on STM32 devices from ST and AVR32 devices from Atmel.
* *
* Return value: %TRUE for success * Returns: %TRUE for success
**/ **/
gboolean gboolean
fu_dfu_target_mass_erase (FuDfuTarget *self, GError **error) fu_dfu_target_mass_erase (FuDfuTarget *self, GError **error)
@ -1301,12 +1301,12 @@ fu_dfu_target_download_element (FuDfuTarget *self,
* @self: a #FuDfuTarget * @self: a #FuDfuTarget
* @image: a #FuFirmware * @image: a #FuFirmware
* @flags: flags to use, e.g. %DFU_TARGET_TRANSFER_FLAG_VERIFY * @flags: flags to use, e.g. %DFU_TARGET_TRANSFER_FLAG_VERIFY
* @error: a #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Downloads firmware from the host to the target, optionally verifying * Downloads firmware from the host to the target, optionally verifying
* the transfer. * the transfer.
* *
* Return value: %TRUE for success * Returns: %TRUE for success
**/ **/
gboolean gboolean
fu_dfu_target_download (FuDfuTarget *self, fu_dfu_target_download (FuDfuTarget *self,
@ -1387,7 +1387,7 @@ fu_dfu_target_download (FuDfuTarget *self,
* *
* Gets the alternate setting to use for this interface. * Gets the alternate setting to use for this interface.
* *
* Return value: the alternative setting, typically zero * Returns: the alternative setting, typically zero
**/ **/
guint8 guint8
fu_dfu_target_get_alt_setting (FuDfuTarget *self) fu_dfu_target_get_alt_setting (FuDfuTarget *self)
@ -1400,11 +1400,11 @@ fu_dfu_target_get_alt_setting (FuDfuTarget *self)
/** /**
* fu_dfu_target_get_alt_name: * fu_dfu_target_get_alt_name:
* @self: a #FuDfuTarget * @self: a #FuDfuTarget
* @error: a #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the alternate setting name to use for this interface. * Gets the alternate setting name to use for this interface.
* *
* Return value: the alternative setting name, typically %NULL * Returns: the alternative setting name, typically %NULL
**/ **/
const gchar * const gchar *
fu_dfu_target_get_alt_name (FuDfuTarget *self, GError **error) fu_dfu_target_get_alt_name (FuDfuTarget *self, GError **error)
@ -1431,12 +1431,12 @@ fu_dfu_target_get_alt_name (FuDfuTarget *self, GError **error)
/** /**
* fu_dfu_target_get_alt_name_for_display: * fu_dfu_target_get_alt_name_for_display:
* @self: a #FuDfuTarget * @self: a #FuDfuTarget
* @error: a #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the alternate setting name to use for this interface that can be * Gets the alternate setting name to use for this interface that can be
* shown on the display. * shown on the display.
* *
* Return value: the alternative setting name * Returns: the alternative setting name
**/ **/
const gchar * const gchar *
fu_dfu_target_get_alt_name_for_display (FuDfuTarget *self, GError **error) fu_dfu_target_get_alt_name_for_display (FuDfuTarget *self, GError **error)

2
plugins/intel-spi/fu-efi-common.c
View File

@ -14,7 +14,7 @@
* *
* Converts a GUID to the known nice name. * Converts a GUID to the known nice name.
* *
* Return value: identifier string, or %NULL if unknown * Returns: identifier string, or %NULL if unknown
* *
* Since: 1.6.0 * Since: 1.6.0
**/ **/

6
plugins/intel-spi/fu-ifd-common.c
View File

@ -14,7 +14,7 @@
* *
* Converts a #FuIfdRegion to a string. * Converts a #FuIfdRegion to a string.
* *
* Return value: identifier string * Returns: identifier string
* *
* Since: 1.6.0 * Since: 1.6.0
**/ **/
@ -50,7 +50,7 @@ fu_ifd_region_to_string (FuIfdRegion region)
* *
* Converts a #FuIfdRegion to a name the user might recognize. * Converts a #FuIfdRegion to a name the user might recognize.
* *
* Return value: identifier string * Returns: identifier string
* *
* Since: 1.6.0 * Since: 1.6.0
**/ **/
@ -86,7 +86,7 @@ fu_ifd_region_to_name (FuIfdRegion region)
* *
* Converts a #FuIfdAccess to a string. * Converts a #FuIfdAccess to a string.
* *
* Return value: identifier string * Returns: identifier string
* *
* Since: 1.6.0 * Since: 1.6.0
**/ **/

2
plugins/intel-spi/fu-ifd-firmware.c
View File

@ -246,7 +246,7 @@ fu_ifd_firmware_parse (FuFirmware *firmware,
* *
* Checks a JEDEC command to see if it has been put on the "illegal_jedec" list. * Checks a JEDEC command to see if it has been put on the "illegal_jedec" list.
* *
* Return value: %TRUE if the command is allowed * Returns: %TRUE if the command is allowed
* *
* Since: 1.6.0 * Since: 1.6.0
**/ **/

2
plugins/intel-spi/fu-ifd-image.c
View File

@ -58,7 +58,7 @@ fu_ifd_image_set_access (FuIfdImage *self, FuIfdRegion region, FuIfdAccess acces
* *
* Gets the access control for a specific reason. * Gets the access control for a specific reason.
* *
* Return value: a #FuIfdAccess, e.g. %FU_IFD_ACCESS_NONE * Returns: a #FuIfdAccess, e.g. %FU_IFD_ACCESS_NONE
* *
* Since: 1.6.0 * Since: 1.6.0
**/ **/

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

@ -706,7 +706,7 @@ fu_device_list_add (FuDeviceList *self, FuDevice *device)
* fu_device_list_get_by_guid: * fu_device_list_get_by_guid:
* @self: A #FuDeviceList * @self: A #FuDeviceList
* @guid: A device GUID * @guid: A device GUID
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Finds a specific device that has the matching GUID. * Finds a specific device that has the matching GUID.
* *
@ -751,7 +751,7 @@ fu_device_list_devices_wait_removed (FuDeviceList *self)
* fu_device_list_wait_for_replug: * fu_device_list_wait_for_replug:
* @self: A #FuDeviceList * @self: A #FuDeviceList
* @device: A #FuDevice * @device: A #FuDevice
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Waits for a specific device to replug if %FWUPD_DEVICE_FLAG_WAIT_FOR_REPLUG * Waits for a specific device to replug if %FWUPD_DEVICE_FLAG_WAIT_FOR_REPLUG
* is set. * is set.
@ -857,7 +857,7 @@ fu_device_list_wait_for_replug (FuDeviceList *self, FuDevice *device, GError **e
* fu_device_list_get_by_id: * fu_device_list_get_by_id:
* @self: A #FuDeviceList * @self: A #FuDeviceList
* @device_id: A device ID, typically a SHA1 hash * @device_id: A device ID, typically a SHA1 hash
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Finds a specific device using the ID string. This function also supports * Finds a specific device using the ID string. This function also supports
* using abbreviated hashes. * using abbreviated hashes.

54
src/fu-engine.c
View File

@ -585,7 +585,7 @@ fu_engine_get_remote_id_for_checksum (FuEngine *self, const gchar *csum)
* fu_engine_unlock: * fu_engine_unlock:
* @self: A #FuEngine * @self: A #FuEngine
* @device_id: A device ID * @device_id: A device ID
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Unlocks a device. * Unlocks a device.
* *
@ -661,7 +661,7 @@ fu_engine_modify_config (FuEngine *self, const gchar *key, const gchar *value, G
* @remote_id: A remote ID * @remote_id: A remote ID
* @key: the key, e.g. `Enabled` * @key: the key, e.g. `Enabled`
* @value: the key, e.g. `true` * @value: the key, e.g. `true`
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Updates the verification silo entry for a specific device. * Updates the verification silo entry for a specific device.
* *
@ -703,7 +703,7 @@ fu_engine_modify_remote (FuEngine *self,
* @device_id: A device ID * @device_id: A device ID
* @key: the key, e.g. `Flags` * @key: the key, e.g. `Flags`
* @value: the key, e.g. `reported` * @value: the key, e.g. `reported`
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Sets the reported flag for a specific device. This ensures that other * Sets the reported flag for a specific device. This ensures that other
* front-end clients for fwupd do not report the same event. * front-end clients for fwupd do not report the same event.
@ -770,7 +770,7 @@ fu_engine_checksum_type_to_string (GChecksumType checksum_type)
* fu_engine_verify_update: * fu_engine_verify_update:
* @self: A #FuEngine * @self: A #FuEngine
* @device_id: A device ID * @device_id: A device ID
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Updates the verification silo entry for a specific device. * Updates the verification silo entry for a specific device.
* *
@ -1016,7 +1016,7 @@ fu_engine_verify_from_system_metadata (FuEngine *self,
* fu_engine_verify: * fu_engine_verify:
* @self: A #FuEngine * @self: A #FuEngine
* @device_id: A device ID * @device_id: A device ID
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Verifies a device firmware checksum using the verification silo entry. * Verifies a device firmware checksum using the verification silo entry.
* *
@ -1850,7 +1850,7 @@ fu_engine_get_report_metadata (FuEngine *self, GError **error)
* fu_engine_composite_prepare: * fu_engine_composite_prepare:
* @self: A #FuEngine * @self: A #FuEngine
* @devices: (element-type #FuDevice): devices that will be updated * @devices: (element-type #FuDevice): devices that will be updated
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Calls into the plugin loader, informing each plugin of the pending upgrade(s). * Calls into the plugin loader, informing each plugin of the pending upgrade(s).
* *
@ -1874,7 +1874,7 @@ fu_engine_composite_prepare (FuEngine *self, GPtrArray *devices, GError **error)
* fu_engine_composite_cleanup: * fu_engine_composite_cleanup:
* @self: A #FuEngine * @self: A #FuEngine
* @devices: (element-type #FuDevice): devices that will be updated * @devices: (element-type #FuDevice): devices that will be updated
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Calls into the plugin loader, informing each plugin of the pending upgrade(s). * Calls into the plugin loader, informing each plugin of the pending upgrade(s).
* *
@ -1899,7 +1899,7 @@ fu_engine_composite_cleanup (FuEngine *self, GPtrArray *devices, GError **error)
* @install_tasks: (element-type FuInstallTask): A #FuDevice * @install_tasks: (element-type FuInstallTask): A #FuDevice
* @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: (nullable): optional return location for an error
* *
* Installs a specific firmware file on one or more install tasks. * Installs a specific firmware file on one or more install tasks.
* *
@ -2122,7 +2122,7 @@ fu_engine_offline_invalidate (GError **error)
* @release: A #FwupdRelease * @release: A #FwupdRelease
* @blob_cab: A #GBytes * @blob_cab: A #GBytes
* @flags: #FwupdInstallFlags * @flags: #FwupdInstallFlags
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Schedule an offline update for the device * Schedule an offline update for the device
* *
@ -2398,7 +2398,7 @@ fu_engine_sort_releases (FuEngine *self, FuDevice *device, GPtrArray *rels, GErr
* @task: A #FuInstallTask * @task: A #FuInstallTask
* @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: (nullable): optional return location for an error
* *
* Installs a specific firmware file on a device. * Installs a specific firmware file on a device.
* *
@ -2554,7 +2554,7 @@ fu_engine_get_plugins (FuEngine *self)
* fu_engine_get_device: * fu_engine_get_device:
* @self: A #FuEngine * @self: A #FuEngine
* @device_id: A device ID * @device_id: A device ID
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets a specific device. * Gets a specific device.
* *
@ -3659,7 +3659,7 @@ fu_engine_validate_result_timestamp (JcatResult *jcat_result,
* @remote_id: A remote ID, e.g. `lvfs` * @remote_id: A remote ID, e.g. `lvfs`
* @bytes_raw: Blob of metadata * @bytes_raw: Blob of metadata
* @bytes_sig: Blob of metadata signature, typically Jcat binary format * @bytes_sig: Blob of metadata signature, typically Jcat binary format
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Updates the metadata for a specific remote. * Updates the metadata for a specific remote.
* *
@ -3794,7 +3794,7 @@ fu_engine_update_metadata_bytes (FuEngine *self, const gchar *remote_id,
* @remote_id: A remote ID, e.g. `lvfs` * @remote_id: A remote ID, e.g. `lvfs`
* @fd: file descriptor of the metadata * @fd: file descriptor of the metadata
* @fd_sig: file descriptor of the metadata signature * @fd_sig: file descriptor of the metadata signature
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Updates the metadata for a specific remote. * Updates the metadata for a specific remote.
* *
@ -3849,7 +3849,7 @@ fu_engine_update_metadata (FuEngine *self, const gchar *remote_id,
* fu_engine_get_silo_from_blob: * fu_engine_get_silo_from_blob:
* @self: A #FuEngine * @self: A #FuEngine
* @blob_cab: A #GBytes * @blob_cab: A #GBytes
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Creates a silo from a .cab file blob. * Creates a silo from a .cab file blob.
* *
@ -4016,7 +4016,7 @@ fu_engine_get_details_sort_cb (gconstpointer a, gconstpointer b)
* @self: A #FuEngine * @self: A #FuEngine
* @request: A #FuEngineRequest * @request: A #FuEngineRequest
* @fd: A file descriptor * @fd: A file descriptor
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the details about a local file. * Gets the details about a local file.
* *
@ -4144,7 +4144,7 @@ fu_engine_sort_devices_by_priority_name (gconstpointer a, gconstpointer b)
/** /**
* fu_engine_get_devices: * fu_engine_get_devices:
* @self: A #FuEngine * @self: A #FuEngine
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the list of devices. * Gets the list of devices.
* *
@ -4174,7 +4174,7 @@ fu_engine_get_devices (FuEngine *self, GError **error)
* fu_engine_get_devices_by_guid: * fu_engine_get_devices_by_guid:
* @self: A #FuEngine * @self: A #FuEngine
* @guid: A GUID * @guid: A GUID
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets a specific device. * Gets a specific device.
* *
@ -4212,7 +4212,7 @@ fu_engine_get_devices_by_guid (FuEngine *self, const gchar *guid, GError **error
* fu_engine_get_devices_by_composite_id: * fu_engine_get_devices_by_composite_id:
* @self: A #FuEngine * @self: A #FuEngine
* @composite_id: A device ID * @composite_id: A device ID
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets all devices that match a specific composite ID. * Gets all devices that match a specific composite ID.
* *
@ -4273,7 +4273,7 @@ fu_engine_get_history_set_hsi_attrs (FuEngine *self, FuDevice *device)
/** /**
* fu_engine_get_history: * fu_engine_get_history:
* @self: A #FuEngine * @self: A #FuEngine
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the list of history. * Gets the list of history.
* *
@ -4348,7 +4348,7 @@ g_ptr_array_copy (GPtrArray *array, GCopyFunc func, gpointer user_data)
/** /**
* fu_engine_get_remotes: * fu_engine_get_remotes:
* @self: A #FuEngine * @self: A #FuEngine
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the list of remotes in use by the engine. * Gets the list of remotes in use by the engine.
* *
@ -4379,7 +4379,7 @@ fu_engine_get_remotes (FuEngine *self, GError **error)
* fu_engine_get_remote_by_id: * fu_engine_get_remote_by_id:
* @self: A #FuEngine * @self: A #FuEngine
* @remote_id: A string representation of a remote * @remote_id: A string representation of a remote
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the FwupdRemote object. * Gets the FwupdRemote object.
* *
@ -4712,7 +4712,7 @@ fu_engine_get_releases_for_device (FuEngine *self,
* @self: A #FuEngine * @self: A #FuEngine
* @request: A #FuEngineRequest * @request: A #FuEngineRequest
* @device_id: A device ID * @device_id: A device ID
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the releases available for a specific device. * Gets the releases available for a specific device.
* *
@ -4756,7 +4756,7 @@ fu_engine_get_releases (FuEngine *self,
* @self: A #FuEngine * @self: A #FuEngine
* @request: A #FuEngineRequest * @request: A #FuEngineRequest
* @device_id: A device ID * @device_id: A device ID
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the downgrades available for a specific device. * Gets the downgrades available for a specific device.
* *
@ -4965,7 +4965,7 @@ fu_engine_self_sign (FuEngine *self,
* @self: A #FuEngine * @self: A #FuEngine
* @request: A #FuEngineRequest * @request: A #FuEngineRequest
* @device_id: A device ID * @device_id: A device ID
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the upgrades available for a specific device. * Gets the upgrades available for a specific device.
* *
@ -5077,7 +5077,7 @@ fu_engine_get_upgrades (FuEngine *self,
* fu_engine_clear_results: * fu_engine_clear_results:
* @self: A #FuEngine * @self: A #FuEngine
* @device_id: A device ID * @device_id: A device ID
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Clear the historical state of a specific device operation. * Clear the historical state of a specific device operation.
* *
@ -5125,7 +5125,7 @@ fu_engine_clear_results (FuEngine *self, const gchar *device_id, GError **error)
* fu_engine_get_results: * fu_engine_get_results:
* @self: A #FuEngine * @self: A #FuEngine
* @device_id: A device ID * @device_id: A device ID
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Gets the historical state of a specific device operation. * Gets the historical state of a specific device operation.
* *
@ -6279,7 +6279,7 @@ fu_engine_ensure_client_certificate (FuEngine *self)
* fu_engine_load: * fu_engine_load:
* @self: A #FuEngine * @self: A #FuEngine
* @flags: #FuEngineLoadFlags, e.g. %FU_ENGINE_LOAD_FLAG_READONLY * @flags: #FuEngineLoadFlags, e.g. %FU_ENGINE_LOAD_FLAG_READONLY
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Load the firmware update engine so it is ready for use. * Load the firmware update engine so it is ready for use.
* *

28
src/fu-history.c
View File

@ -487,7 +487,7 @@ fu_history_get_device_flags_filtered (FuDevice *device)
* fu_history_modify_device: * fu_history_modify_device:
* @self: A #FuHistory * @self: A #FuHistory
* @device: A #FuDevice * @device: A #FuDevice
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Modify a device in the history database * Modify a device in the history database
* *
@ -548,7 +548,7 @@ fu_history_modify_device (FuHistory *self, FuDevice *device, GError **error)
* @self: A #FuHistory * @self: A #FuHistory
* @device_id: A DeviceID string * @device_id: A DeviceID string
* @metadata: A #GHashTable of string:string * @metadata: A #GHashTable of string:string
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Modify a device in the history database * Modify a device in the history database
* *
@ -604,7 +604,7 @@ fu_history_set_device_metadata (FuHistory *self,
* @self: A #FuHistory * @self: A #FuHistory
* @device: A #FuDevice * @device: A #FuDevice
* @release: A #FuRelease * @release: A #FuRelease
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Adds a device to the history database * Adds a device to the history database
* *
@ -697,7 +697,7 @@ fu_history_add_device (FuHistory *self, FuDevice *device, FwupdRelease *release,
* fu_history_remove_all_with_state: * fu_history_remove_all_with_state:
* @self: A #FuHistory * @self: A #FuHistory
* @update_state: A #FwupdUpdateState * @update_state: A #FwupdUpdateState
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Remove all devices from the history database that match * Remove all devices from the history database that match
* state update_state * state update_state
@ -742,7 +742,7 @@ fu_history_remove_all_with_state (FuHistory *self,
/** /**
* fu_history_remove_all: * fu_history_remove_all:
* @self: A #FuHistory * @self: A #FuHistory
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Remove all devices from the history database * Remove all devices from the history database
* *
@ -781,7 +781,7 @@ fu_history_remove_all (FuHistory *self, GError **error)
* fu_history_remove_device: * fu_history_remove_device:
* @self: A #FuHistory * @self: A #FuHistory
* @device: A #FuDevice * @device: A #FuDevice
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Remove a device from the history database * Remove a device from the history database
* *
@ -826,7 +826,7 @@ fu_history_remove_device (FuHistory *self, FuDevice *device, GError **error)
* fu_history_get_device_by_id: * fu_history_get_device_by_id:
* @self: A #FuHistory * @self: A #FuHistory
* @device_id: A string * @device_id: A string
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Returns the device from the history database or NULL if not found * Returns the device from the history database or NULL if not found
* *
@ -893,7 +893,7 @@ fu_history_get_device_by_id (FuHistory *self, const gchar *device_id, GError **e
/** /**
* fu_history_get_devices: * fu_history_get_devices:
* @self: A #FuHistory * @self: A #FuHistory
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Gets the devices in the history database. * Gets the devices in the history database.
* *
@ -956,7 +956,7 @@ fu_history_get_devices (FuHistory *self, GError **error)
/** /**
* fu_history_get_approved_firmware: * fu_history_get_approved_firmware:
* @self: A #FuHistory * @self: A #FuHistory
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Returns approved firmware records. * Returns approved firmware records.
* *
@ -1009,7 +1009,7 @@ fu_history_get_approved_firmware (FuHistory *self, GError **error)
/** /**
* fu_history_clear_approved_firmware: * fu_history_clear_approved_firmware:
* @self: A #FuHistory * @self: A #FuHistory
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Clear all approved firmware records * Clear all approved firmware records
* *
@ -1049,7 +1049,7 @@ fu_history_clear_approved_firmware (FuHistory *self, GError **error)
* fu_history_add_approved_firmware: * fu_history_add_approved_firmware:
* @self: A #FuHistory * @self: A #FuHistory
* @checksum: a string * @checksum: a string
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Add an approved firmware record to the database * Add an approved firmware record to the database
* *
@ -1091,7 +1091,7 @@ fu_history_add_approved_firmware (FuHistory *self,
/** /**
* fu_history_get_blocked_firmware: * fu_history_get_blocked_firmware:
* @self: A #FuHistory * @self: A #FuHistory
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Returns blocked firmware records. * Returns blocked firmware records.
* *
@ -1144,7 +1144,7 @@ fu_history_get_blocked_firmware (FuHistory *self, GError **error)
/** /**
* fu_history_clear_blocked_firmware: * fu_history_clear_blocked_firmware:
* @self: A #FuHistory * @self: A #FuHistory
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Clear all blocked firmware records * Clear all blocked firmware records
* *
@ -1184,7 +1184,7 @@ fu_history_clear_blocked_firmware (FuHistory *self, GError **error)
* fu_history_add_blocked_firmware: * fu_history_add_blocked_firmware:
* @self: A #FuHistory * @self: A #FuHistory
* @checksum: a string * @checksum: a string
* @error: A #GError or NULL * @error: (nullable): optional return location for an error
* *
* Add an blocked firmware record to the database * Add an blocked firmware record to the database
* *

2
src/fu-install-task.c
View File

@ -186,7 +186,7 @@ fu_install_task_check_requirements_version_check (FuInstallTask *self, GError **
* fu_install_task_check_requirements: * fu_install_task_check_requirements:
* @self: A #FuInstallTask * @self: A #FuInstallTask
* @flags: A #FwupdInstallFlags, e.g. #FWUPD_INSTALL_FLAG_ALLOW_OLDER * @flags: A #FwupdInstallFlags, e.g. #FWUPD_INSTALL_FLAG_ALLOW_OLDER
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Checks any requirements of this task. This will typically involve checking * Checks any requirements of this task. This will typically involve checking
* that the device can accept the component (the GUIDs match) and that the * that the device can accept the component (the GUIDs match) and that the

2
src/fu-keyring-utils.c
View File

@ -17,7 +17,7 @@
* fu_keyring_get_release_flags: * fu_keyring_get_release_flags:
* @release: A #XbNode * @release: A #XbNode
* @flags: A #FwupdReleaseFlags, e.g. %FWUPD_RELEASE_FLAG_TRUSTED_PAYLOAD * @flags: A #FwupdReleaseFlags, e.g. %FWUPD_RELEASE_FLAG_TRUSTED_PAYLOAD
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Uses the correct keyring to get the trust flags for a given release. * Uses the correct keyring to get the trust flags for a given release.
* *

4
src/fu-plugin-list.c
View File

@ -80,7 +80,7 @@ fu_plugin_list_add (FuPluginList *self, FuPlugin *plugin)
* fu_plugin_list_find_by_name: * fu_plugin_list_find_by_name:
* @self: A #FuPluginList * @self: A #FuPluginList
* @name: A #FuPlugin name, e.g. "dfu" * @name: A #FuPlugin name, e.g. "dfu"
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Finds a specific plugin using the plugin name. * Finds a specific plugin using the plugin name.
* *
@ -117,7 +117,7 @@ fu_plugin_list_sort_cb (gconstpointer a, gconstpointer b)
/** /**
* fu_plugin_list_depsolve: * fu_plugin_list_depsolve:
* @self: A #FuPluginList * @self: A #FuPluginList
* @error: A #GError, or %NULL * @error: (nullable): optional return location for an error
* *
* Depsolves the list of plugins into the correct order. Some plugin methods * Depsolves the list of plugins into the correct order. Some plugin methods
* are called on all plugins and for some situations the order they are called * are called on all plugins and for some situations the order they are called

2
src/fu-util-common.c
View File

@ -1014,7 +1014,7 @@ fu_util_convert_description (const gchar *xml, GError **error)
* *
* Converts a timestamp to a 'pretty' translated string * Converts a timestamp to a 'pretty' translated string
* *
* Return value: (transfer full): A string * Returns: (transfer full): A string
* *
* Since: 1.3.7 * Since: 1.3.7
**/ **/