mirror of
https://git.proxmox.com/git/fwupd
synced 2025-08-14 21:50:25 +00:00
trivial: Fix some Gtk-Doc mistakes
Fixes https://github.com/hughsie/fwupd/issues/487
This commit is contained in:
parent
f6949b4911
commit
8aa7239240
@ -42,6 +42,14 @@ struct _FwupdRemoteClass
|
|||||||
void (*_fwupd_reserved7) (void);
|
void (*_fwupd_reserved7) (void);
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* FwupdRemoteKind:
|
||||||
|
* @FWUPD_REMOTE_KIND_UNKNOWN: Unknown kind
|
||||||
|
* @FWUPD_REMOTE_KIND_DOWNLOAD: Requires files to be downloaded
|
||||||
|
* @FWUPD_REMOTE_KIND_LOCAL: Reads files from the local machine
|
||||||
|
*
|
||||||
|
* The kind of remote.
|
||||||
|
**/
|
||||||
typedef enum {
|
typedef enum {
|
||||||
FWUPD_REMOTE_KIND_UNKNOWN,
|
FWUPD_REMOTE_KIND_UNKNOWN,
|
||||||
FWUPD_REMOTE_KIND_DOWNLOAD,
|
FWUPD_REMOTE_KIND_DOWNLOAD,
|
||||||
|
@ -117,7 +117,7 @@ fu_common_get_file_list_internal (GPtrArray *files, const gchar *directory, GErr
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* fu_common_get_files_recursive:
|
* fu_common_get_files_recursive:
|
||||||
* @directory: a directory name
|
* @path: a directory name
|
||||||
* @error: A #GError or %NULL
|
* @error: A #GError or %NULL
|
||||||
*
|
*
|
||||||
* Returns every file found under @directory, and any subdirectory.
|
* Returns every file found under @directory, and any subdirectory.
|
||||||
@ -599,7 +599,7 @@ fu_common_spawn_sync (const gchar * const * argv,
|
|||||||
* fu_common_write_uint16:
|
* fu_common_write_uint16:
|
||||||
* @buf: A writable buffer
|
* @buf: A writable buffer
|
||||||
* @val_native: a value in host byte-order
|
* @val_native: a value in host byte-order
|
||||||
* @error: A #FuEndianType, e.g. %G_LITTLE_ENDIAN
|
* @endian: A #FuEndianType, e.g. %G_LITTLE_ENDIAN
|
||||||
*
|
*
|
||||||
* Writes a value to a buffer using a specified endian.
|
* Writes a value to a buffer using a specified endian.
|
||||||
**/
|
**/
|
||||||
@ -624,7 +624,7 @@ fu_common_write_uint16 (guint8 *buf, guint16 val_native, FuEndianType endian)
|
|||||||
* fu_common_write_uint32:
|
* fu_common_write_uint32:
|
||||||
* @buf: A writable buffer
|
* @buf: A writable buffer
|
||||||
* @val_native: a value in host byte-order
|
* @val_native: a value in host byte-order
|
||||||
* @error: A #FuEndianType, e.g. %G_LITTLE_ENDIAN
|
* @endian: A #FuEndianType, e.g. %G_LITTLE_ENDIAN
|
||||||
*
|
*
|
||||||
* Writes a value to a buffer using a specified endian.
|
* Writes a value to a buffer using a specified endian.
|
||||||
**/
|
**/
|
||||||
@ -648,7 +648,7 @@ fu_common_write_uint32 (guint8 *buf, guint32 val_native, FuEndianType endian)
|
|||||||
/**
|
/**
|
||||||
* fu_common_read_uint16:
|
* fu_common_read_uint16:
|
||||||
* @buf: A readable buffer
|
* @buf: A readable buffer
|
||||||
* @error: A #FuEndianType, e.g. %G_LITTLE_ENDIAN
|
* @endian: A #FuEndianType, e.g. %G_LITTLE_ENDIAN
|
||||||
*
|
*
|
||||||
* Read a value from a buffer using a specified endian.
|
* Read a value from a buffer using a specified endian.
|
||||||
*
|
*
|
||||||
@ -675,7 +675,7 @@ fu_common_read_uint16 (const guint8 *buf, FuEndianType endian)
|
|||||||
/**
|
/**
|
||||||
* fu_common_read_uint32:
|
* fu_common_read_uint32:
|
||||||
* @buf: A readable buffer
|
* @buf: A readable buffer
|
||||||
* @error: A #FuEndianType, e.g. %G_LITTLE_ENDIAN
|
* @endian: A #FuEndianType, e.g. %G_LITTLE_ENDIAN
|
||||||
*
|
*
|
||||||
* Read a value from a buffer using a specified endian.
|
* Read a value from a buffer using a specified endian.
|
||||||
*
|
*
|
||||||
|
@ -357,7 +357,6 @@ fu_device_list_add_missing_guids (FuDevice *device_new, FuDevice *device_old)
|
|||||||
* fu_device_list_add:
|
* fu_device_list_add:
|
||||||
* @self: A #FuDeviceList
|
* @self: A #FuDeviceList
|
||||||
* @device: A #FuDevice
|
* @device: A #FuDevice
|
||||||
* @error: A #GError, or %NULL
|
|
||||||
*
|
*
|
||||||
* Adds a specific device to the device list if not already present.
|
* Adds a specific device to the device list if not already present.
|
||||||
*
|
*
|
||||||
|
@ -31,10 +31,19 @@ G_BEGIN_DECLS
|
|||||||
#define FU_TYPE_PENDING (fu_history_get_type ())
|
#define FU_TYPE_PENDING (fu_history_get_type ())
|
||||||
G_DECLARE_FINAL_TYPE (FuHistory, fu_history, FU, HISTORY, GObject)
|
G_DECLARE_FINAL_TYPE (FuHistory, fu_history, FU, HISTORY, GObject)
|
||||||
|
|
||||||
|
/**
|
||||||
|
* FuHistoryFlags:
|
||||||
|
* @FU_HISTORY_FLAGS_NONE: No flags set
|
||||||
|
* @FU_HISTORY_FLAGS_MATCH_OLD_VERSION: Match previous firmware version
|
||||||
|
* @FU_HISTORY_FLAGS_MATCH_NEW_VERSION: Match new firmware version
|
||||||
|
*
|
||||||
|
* The flags to use when matching devices against the history database.
|
||||||
|
**/
|
||||||
typedef enum {
|
typedef enum {
|
||||||
FU_HISTORY_FLAGS_NONE = 0,
|
FU_HISTORY_FLAGS_NONE = 0,
|
||||||
FU_HISTORY_FLAGS_MATCH_OLD_VERSION = 1 << 0,
|
FU_HISTORY_FLAGS_MATCH_OLD_VERSION = 1 << 0,
|
||||||
FU_HISTORY_FLAGS_MATCH_NEW_VERSION = 1 << 1,
|
FU_HISTORY_FLAGS_MATCH_NEW_VERSION = 1 << 1,
|
||||||
|
/*< private >*/
|
||||||
FU_HISTORY_FLAGS_LAST
|
FU_HISTORY_FLAGS_LAST
|
||||||
} FuHistoryFlags;
|
} FuHistoryFlags;
|
||||||
|
|
||||||
|
@ -460,6 +460,7 @@ fu_usb_device_get_dev (FuUsbDevice *device)
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* fu_usb_device_new:
|
* fu_usb_device_new:
|
||||||
|
* @usb_device: A #GUsbDevice
|
||||||
*
|
*
|
||||||
* Creates a new #FuUsbDevice.
|
* Creates a new #FuUsbDevice.
|
||||||
*
|
*
|
||||||
|
Loading…
Reference in New Issue
Block a user