docs: Mention the types of params in event callbacks

Signed-off-by: Han Han <hhan@redhat.com>
Reviewed-by: Andrea Bolognani <abologna@redhat.com>

diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-domain.h
index 06473619523e8accced84b24ccddb2386e84c2fd..4da1a63a14c525eb57c0592366f887a252521e89 100644 (file)
--- a/include/libvirt/libvirt-domain.h
+++ b/include/libvirt/libvirt-domain.h
@@ -3281,7 +3281,7 @@ typedef enum {
  * @conn: virConnect connection
  * @dom: The domain on which the event occurred
  * @event: The specific virDomainEventType which occurred
- * @detail: event specific detail information
+ * @detail: event specific detail information (virDomainEvent*DetailType)
  * @opaque: opaque user data
  *
  * A callback function to be registered, and called when a domain event occurs
@@ -3783,7 +3783,7 @@ typedef enum {
  * virConnectDomainEventWatchdogCallback:
  * @conn: connection object
  * @dom: domain on which the event occurred
- * @action: action that is to be taken due to watchdog firing
+ * @action: action that is to be taken due to watchdog firing (virDomainEventWatchdogAction)
  * @opaque: application specified data
  *
  * The callback signature to use when registering for an event of type
@@ -3817,7 +3817,7 @@ typedef enum {
  * @dom: domain on which the event occurred
  * @srcPath: The host file on which the IO error occurred
  * @devAlias: The guest device alias associated with the path
- * @action: action that is to be taken due to the IO error
+ * @action: action that is to be taken due to the IO error (virDomainEventIOErrorAction)
  * @opaque: application specified data
  *
  * The callback signature to use when registering for an event of type
@@ -3836,7 +3836,7 @@ typedef void (*virConnectDomainEventIOErrorCallback)(virConnectPtr conn,
  * @dom: domain on which the event occurred
  * @srcPath: The host file on which the IO error occurred
  * @devAlias: The guest device alias associated with the path
- * @action: action that is to be taken due to the IO error
+ * @action: action that is to be taken due to the IO error (virDomainEventIOErrorAction)
  * @reason: the cause of the IO error
  * @opaque: application specified data
  *
@@ -3940,7 +3940,7 @@ typedef virDomainEventGraphicsSubject *virDomainEventGraphicsSubjectPtr;
  * virConnectDomainEventGraphicsCallback:
  * @conn: connection object
  * @dom: domain on which the event occurred
- * @phase: the phase of the connection
+ * @phase: the phase of the connection (virDomainEventGraphicsPhase)
  * @local: the local server address
  * @remote: the remote client address
  * @authScheme: the authentication scheme activated
@@ -4072,7 +4072,7 @@ typedef enum {
  * @conn: connection object
  * @dom: domain on which the event occurred
  * @devAlias: device alias
- * @reason: why the tray status was changed?
+ * @reason: why the tray status was changed? (virDomainEventTrayChangeReason)
  * @opaque: application specified data
  *
  * This callback occurs when the tray of a removable device is moved.
@@ -4653,7 +4653,7 @@ typedef void (*virConnectDomainEventBlockThresholdCallback)(virConnectPtr conn,
  *             (virDomainMemoryFailureRecipientType)
  * @action: the action of hardware memory failure
  *          (virDomainMemoryFailureActionType)
- * @flags: the flags of hardware memory failure
+ * @flags: the flags of hardware memory failure (virDomainMemoryFailureFlags)
  * @opaque: application specified data
  *
  * The callback occurs when the hypervisor handles the hardware memory

diff --git a/include/libvirt/libvirt-secret.h b/include/libvirt/libvirt-secret.h
index bc1286883ce5f702284aecb5fd162ccce83edfcb..a75abc832a9e07a8468f89996dfc7c65e1975000 100644 (file)
--- a/include/libvirt/libvirt-secret.h
+++ b/include/libvirt/libvirt-secret.h
@@ -191,7 +191,7 @@ typedef enum {
  * @conn: connection object
  * @secret: secret on which the event occurred
  * @event: The specific virSecretEventLifecycleType which occurred
- * @detail: contains some details on the reason of the event.
+ * @detail: contains some details on the reason of the event (currently unused)
  * @opaque: application specified data
  *
  * This callback is called when a secret lifecycle action is performed,

diff --git a/include/libvirt/libvirt-storage.h b/include/libvirt/libvirt-storage.h
index f8c665a18f16758ba4fb6baaccec1d7b9867fd70..bee738880dd67750d92fa062bec4b516ddc47dc4 100644 (file)
--- a/include/libvirt/libvirt-storage.h
+++ b/include/libvirt/libvirt-storage.h
@@ -489,7 +489,7 @@ typedef enum {
  * @conn: connection object
  * @pool: pool on which the event occurred
  * @event: The specific virStoragePoolEventLifecycleType which occurred
- * @detail: contains some details on the reason of the event.
+ * @detail: contains some details on the reason of the event (currently unused)
  * @opaque: application specified data
  *
  * This callback is called when a pool lifecycle action is performed, like start