From: Peter Krempa <pkrempa@redhat.com>
Date: Wed, 20 Mar 2019 13:13:42 +0000 (+0100)
Subject: conf: Document virDomainDiskSourceFormat
X-Git-Tag: v5.3.0-rc1~321
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=54fc720d8e58e7103b644d0970dc78cf298512ee;p=thirdparty%2Flibvirt.git

conf: Document virDomainDiskSourceFormat

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
---

diff --git a/src/conf/domain_conf.c b/src/conf/domain_conf.c
index 5f55a7382d..265d44eea2 100644
--- a/src/conf/domain_conf.c
+++ b/src/conf/domain_conf.c
@@ -23716,6 +23716,18 @@ virDomainDiskSourceFormatPrivateData(virBufferPtr buf,
 }
 
 
+/**
+ * virDomainDiskSourceFormat:
+ * @buf: output buffer
+ * @src: storage source definition to format
+ * @policy: startup policy attribute value, if necessary
+ * @attrIndex: the 'index' attribute of <source> is formatted if true
+ * @flags: XML formatter flags
+ * @xmlopt: XML formatter callbacks
+ *
+ * Formats @src into a <source> element. Note that this doesn't format the
+ * 'type' and 'format' properties of @src.
+ */
 int
 virDomainDiskSourceFormat(virBufferPtr buf,
                           virStorageSourcePtr src,