virDomainCoreDumpWithFormat: Mention enum for @dumpformat

So the API takes @dumpformat argument. This is what makes it special
when compared to virDomainCoreDump. The argument is there so that
users can choose the format of resulting core dump file. And to ease
them the choosing process we even have an enum with supported values
across all the hypervisors. But we don't mention the enum in  the
function description anywhere. Fix it!

Signed-off-by: Michal Privoznik <mprivozn@redhat.com>

diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c
index 837933f31a21b1634a5e91c1319d9113d982759a..dc89bab1191102e16f3fce858764b79e105caef2 100644 (file)
--- a/src/libvirt-domain.c
+++ b/src/libvirt-domain.c
@@ -1281,7 +1281,7 @@ virDomainCoreDump(virDomainPtr domain, const char *to, unsigned int flags)
  * virDomainCoreDumpWithFormat:
  * @domain: a domain object
  * @to: path for the core file
- * @dumpformat: format of domain memory's dump
+ * @dumpformat: format of domain memory's dump (one of virDomainCoreDumpFormat enum)
  * @flags: bitwise-OR of virDomainCoreDumpFlags
  *
  * This method will dump the core of a domain on a given file for analysis.