qemu: blockjob: Document qemuBlockJobRegister

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
ACKed-by: Eric Blake <eblake@redhat.com>

diff --git a/src/qemu/qemu_blockjob.c b/src/qemu/qemu_blockjob.c
index e63dc49e921683d5b7e14a32fd31cd66dd0cd978..ac7b3a0aef520a07c669511449550b7062d41f3c 100644 (file)
--- a/src/qemu/qemu_blockjob.c
+++ b/src/qemu/qemu_blockjob.c
@@ -117,6 +117,16 @@ qemuBlockJobDataNew(qemuBlockJobType type,
 }
 
 
+/**
+ * qemuBlockJobRegister:
+ * @job: job to register
+ * @vm: domain to register @job with
+ * @disk: disk to register @job with
+ * @savestatus: save the status XML after registering
+ *
+ * This function registers @job with @disk and @vm and records it into the status
+ * xml (if @savestatus is true).
+ */
 int
 qemuBlockJobRegister(qemuBlockJobDataPtr job,
                      virDomainObjPtr vm,