Re: [libvirt] [PATCH 0/2] documentation fixes for virConnectClose and virConnectDomainEventBlockJobCallback
At Wed, 30 Jan 2013 08:49:51 +0100,
Claudio Bley wrote:
Hi.
This series fixes some documentation glitches that broke the build
when rejecting missing documentation in apibuild.py.
See https://www.redhat.com/archives/libvir-list/2013-January/msg02020.html
Claudio Bley (2):
libvirt.h.in: add missing documentation for virConnectCloseFunc
libvirt.h.in: fix documentation for
virConnectDomainEventBlockJobCallback
Additionally to those changes, I forgot to fix
virEventRemoveHandleFunc's return documentation.
When reviewing, please also take the following into account:
---- >8 -----
From c538974eb4f24bd9a74ed6314a995852dcd33bf1 Mon Sep 17 00:00:00 2001
From: Claudio Bley <cbley(a)av-test.de>
Date: Wed, 30 Jan 2013 09:25:16 +0100
Subject: [PATCH] libvirt.h.in: add missing return doc for
virEventRemoveHandleFunc
Organization: AV-Test GmbH, Germany
Signed-off-by: Claudio Bley <cbley(a)av-test.de>
---
include/libvirt/libvirt.h.in | 2 ++
1 file changed, 2 insertions(+)
diff --git a/include/libvirt/libvirt.h.in b/include/libvirt/libvirt.h.in
index c8454b2..793d26f 100644
--- a/include/libvirt/libvirt.h.in
+++ b/include/libvirt/libvirt.h.in
@@ -3533,6 +3533,8 @@ typedef void (*virEventUpdateHandleFunc)(int watch, int event);
* If a virEventHandleFreeFunc was supplied when the handle was
* registered, it will be invoked some time during, or after this
* function call, when it is safe to release the user data.
+ *
+ * Returns -1 if the file handle was not registered, 0 upon success
*/
typedef int (*virEventRemoveHandleFunc)(int watch);