conf: domain: Add comment for 'virDomainObjTaint'

Outline what the function does, especially the return value.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Laine Stump <laine@redhat.com>

diff --git a/src/conf/domain_conf.c b/src/conf/domain_conf.c
index 84ffd93b7f9881bb7308b5692e3cff423073bc99..39ddfb7db0b3817d02e0dcb46148fd10ff048c6f 100644 (file)
--- a/src/conf/domain_conf.c
+++ b/src/conf/domain_conf.c
@@ -1915,8 +1915,17 @@ virDomainBlkioDeviceParseXML(xmlNodePtr root,
 }
 
 
-bool virDomainObjTaint(virDomainObj *obj,
-                       virDomainTaintFlags taint)
+/**
+ * virDomainObjTaint:
+ * @obj: domain object
+ * @taint: domain taint flag
+ *
+ * Marks @obj as tainted by @taint. Returns 'false' if @obj already has
+ * been tainted with @taint.
+ */
+bool
+virDomainObjTaint(virDomainObj *obj,
+                  virDomainTaintFlags taint)
 {
     unsigned int flag = (1 << taint);