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>
This commit is contained in:
Peter Krempa 2023-03-01 17:08:42 +01:00
parent 790ea58153
commit 73d5efaf3c

View File

@ -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);