aboutsummaryrefslogtreecommitdiff
path: root/libmm-glib/mm-firmware-update-settings.c
diff options
context:
space:
mode:
authorAleksander Morgado <aleksander@aleksander.es>2019-10-24 22:58:42 +0200
committerAleksander Morgado <aleksander@aleksander.es>2019-10-28 10:28:31 +0100
commit08d23dd64d4566423579d8fbe609ec6145eae861 (patch)
treea89c7e51adba9ea1670a0d35b28e9aa138fda831 /libmm-glib/mm-firmware-update-settings.c
parent53a7dc2f63ac26edb1a3a8db8368b52cf0417de7 (diff)
docs,libmm-glib: provide per-version indices
Diffstat (limited to 'libmm-glib/mm-firmware-update-settings.c')
-rw-r--r--libmm-glib/mm-firmware-update-settings.c41
1 files changed, 18 insertions, 23 deletions
diff --git a/libmm-glib/mm-firmware-update-settings.c b/libmm-glib/mm-firmware-update-settings.c
index fc8a45bb..defae7c7 100644
--- a/libmm-glib/mm-firmware-update-settings.c
+++ b/libmm-glib/mm-firmware-update-settings.c
@@ -52,6 +52,8 @@ struct _MMFirmwareUpdateSettingsPrivate {
* Gets the methods to use during the firmware update operation.
*
* Returns: a bitmask of #MMModemFirmwareUpdateMethod values.
+ *
+ * Since: 1.10
*/
MMModemFirmwareUpdateMethod
mm_firmware_update_settings_get_method (MMFirmwareUpdateSettings *self)
@@ -67,10 +69,13 @@ mm_firmware_update_settings_get_method (MMFirmwareUpdateSettings *self)
* mm_firmware_update_settings_get_device_ids:
* @self: a #MMFirmwareUpdateSettings.
*
- * Gets the list of device ids used to identify the device during a firmware update
- * operation.
+ * Gets the list of device ids used to identify the device during a firmware
+ * update operation.
+ *
+ * Returns: (transfer none): The list of device ids, or %NULL if unknown. Do not
+ * free the returned value, it is owned by @self.
*
- * Returns: (transfer none): The list of device ids, or %NULL if unknown. Do not free the returned value, it is owned by @self.
+ * Since: 1.10
*/
const gchar **
mm_firmware_update_settings_get_device_ids (MMFirmwareUpdateSettings *self)
@@ -99,7 +104,10 @@ mm_firmware_update_settings_set_device_ids (MMFirmwareUpdateSettings *self,
* Gets firmware version string.
*
*
- * Returns: The version string, or %NULL if unknown. Do not free the returned value, it is owned by @self.
+ * Returns: The version string, or %NULL if unknown. Do not free the returned
+ * value, it is owned by @self.
+ *
+ * Since: 1.10
*/
const gchar *
mm_firmware_update_settings_get_version (MMFirmwareUpdateSettings *self)
@@ -128,9 +136,13 @@ mm_firmware_update_settings_set_version (MMFirmwareUpdateSettings *self,
* Gets the AT command that should be sent to the module to trigger a reset
* into fastboot mode.
*
- * Only applicable if the update method includes %MM_MODEM_FIRMWARE_UPDATE_METHOD_FASTBOOT.
+ * Only applicable if the update method includes
+ * %MM_MODEM_FIRMWARE_UPDATE_METHOD_FASTBOOT.
+ *
+ * Returns: The AT command string, or %NULL if unknown. Do not free the returned
+ * value, it is owned by @self.
*
- * Returns: The AT command string, or %NULL if unknown. Do not free the returned value, it is owned by @self.
+ * Since: 1.10
*/
const gchar *
mm_firmware_update_settings_get_fastboot_at (MMFirmwareUpdateSettings *self)
@@ -154,14 +166,6 @@ mm_firmware_update_settings_set_fastboot_at (MMFirmwareUpdateSettings *self,
/*****************************************************************************/
-/**
- * mm_firmware_update_settings_get_variant:
- * @self: A #MMFirmwareUpdateSettings.
- *
- * Gets a variant with the contents of @self.
- *
- * Returns: (transfer full): A variant with the update settings. The returned value should be freed with g_variant_unref().
- */
GVariant *
mm_firmware_update_settings_get_variant (MMFirmwareUpdateSettings *self)
{
@@ -222,15 +226,6 @@ consume_variant (MMFirmwareUpdateSettings *self,
return TRUE;
}
-/**
- * mm_firmware_update_settings_new_from_variant:
- * @variant: A variant with the update settings.
- * @error: Return location for error or %NULL.
- *
- * Creates a new #MMFirmwareUpdateSettings from the input @variant.
- *
- * Returns: (transfer full): A #MMFirmwareUpdateSettings or %NULL if @error is set. The returned value should be freed with g_object_unref().
- */
MMFirmwareUpdateSettings *
mm_firmware_update_settings_new_from_variant (GVariant *variant,
GError **error)