[PATCHv2 1/7] util: Fix docs for virBitmapParse

[Peter Krempa <pkrempa@xxxxxxxxxx>]

The documentation comment virBitmapParse didn't document the @sep
parameter.
---
 src/util/virbitmap.c | 16 +++++++++-------
 1 file changed, 9 insertions(+), 7 deletions(-)

diff --git a/src/util/virbitmap.c b/src/util/virbitmap.c
index ca82d1b..e3ca4ff 100644
--- a/src/util/virbitmap.c
+++ b/src/util/virbitmap.c
@@ -265,23 +265,25 @@ char *virBitmapFormat(virBitmapPtr bitmap)
 /**
  * virBitmapParse:
  * @str: points to a string representing a human-readable bitmap
+ * @sep: separator character
  * @bitmap: a bitmap created from @str
  * @bitmapSize: the upper limit of num of bits in created bitmap
  *
  * This function is the counterpart of virBitmapFormat. This function creates
  * a bitmap, in which bits are set according to the content of @str.
  *
- * @str is a comma separated string of fields N, which means a number of bit
- * to set, and ^N, which means to unset the bit, and N-M for ranges of bits
- * to set.
+ * @str is a string of fields N separated by a character @sep, which means a
+ * number of bit to set, and ^N, which means to unset the bit, and N-M for
+ * ranges of bits to set.
  *
  * Returns the number of bits set in @bitmap, or -1 in case of error.
  */

-int virBitmapParse(const char *str,
-                   char sep,
-                   virBitmapPtr *bitmap,
-                   size_t bitmapSize)
+int
+virBitmapParse(const char *str,
+               char sep,
+               virBitmapPtr *bitmap,
+               size_t bitmapSize)
 {
     int ret = 0;
     bool neg = false;
-- 
1.8.1.1

--
libvir-list mailing list
libvir-list@xxxxxxxxxx
https://www.redhat.com/mailman/listinfo/libvir-list