]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
util: xml: Use common formatting of 'Bitwise-OR' in function param description
authorPeter Krempa <pkrempa@redhat.com>
Mon, 3 Oct 2022 13:35:12 +0000 (15:35 +0200)
committerPeter Krempa <pkrempa@redhat.com>
Tue, 4 Oct 2022 11:28:14 +0000 (13:28 +0200)
Our public API docs use the hyphenated version with capital OR. Fix the
virXMLProp* helpers to use the same syntax.

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

index c43cc0fd5d14b55088bd68982a18b539bb926077..0548a29e657455382180adb8853c9080cc6e4678 100644 (file)
@@ -557,7 +557,7 @@ virXMLPropEnumInternal(xmlNodePtr node,
  * virXMLPropTristateBool:
  * @node: XML dom node pointer
  * @name: Name of the property (attribute) to get
- * @flags: Bitwise or of virXMLPropFlags
+ * @flags: Bitwise-OR of virXMLPropFlags
  * @result: The returned value
  *
  * Convenience function to return value of a yes / no attribute.
@@ -603,7 +603,7 @@ virXMLPropTristateBoolAllowDefault(xmlNodePtr node,
  * virXMLPropTristateSwitch:
  * @node: XML dom node pointer
  * @name: Name of the property (attribute) to get
- * @flags: Bitwise or of virXMLPropFlags
+ * @flags: Bitwise-OR of virXMLPropFlags
  * @result: The returned value
  *
  * Convenience function to return value of an on / off attribute.
@@ -632,7 +632,7 @@ virXMLPropTristateSwitch(xmlNodePtr node,
  * @node: XML dom node pointer
  * @name: Name of the property (attribute) to get
  * @base: Number base, see strtol
- * @flags: Bitwise or of virXMLPropFlags
+ * @flags: Bitwise-OR of virXMLPropFlags
  * @result: The returned value
  * @defaultResult: default value of @result in case the property is not found
  *
@@ -696,7 +696,7 @@ virXMLPropInt(xmlNodePtr node,
  * @node: XML dom node pointer
  * @name: Name of the property (attribute) to get
  * @base: Number base, see strtol
- * @flags: Bitwise or of virXMLPropFlags
+ * @flags: Bitwise-OR of virXMLPropFlags
  * @result: The returned value
  *
  * Convenience function to return value of an unsigned integer attribute.
@@ -819,7 +819,7 @@ virXMLPropLongLong(xmlNodePtr node,
  * @node: XML dom node pointer
  * @name: Name of the property (attribute) to get
  * @base: Number base, see strtol
- * @flags: Bitwise or of virXMLPropFlags
+ * @flags: Bitwise-OR of virXMLPropFlags
  * @result: The returned value
  *
  * Convenience function to return value of an unsigned long long attribute.
@@ -879,7 +879,7 @@ virXMLPropULongLong(xmlNodePtr node,
  * @name: Name of the property (attribute) to get
  * @strToInt: Conversion function to turn enum name to value. Expected to
  *            return negative value on failure.
- * @flags: Bitwise or of virXMLPropFlags
+ * @flags: Bitwise-OR of virXMLPropFlags
  * @result: The returned value
  * @defaultResult: default value set to @result in case the property is missing
  *
@@ -951,7 +951,7 @@ virXMLPropUUID(xmlNodePtr node,
  * @name: Name of the property (attribute) to get
  * @strToInt: Conversion function to turn enum name to value. Expected to
  *            return negative value on failure.
- * @flags: Bitwise or of virXMLPropFlags
+ * @flags: Bitwise-OR of virXMLPropFlags
  * @result: The returned value
  *
  * Convenience function to return value of an enum attribute.