From 0e3b60b14dd4f40a75d9b265a1e96f1442f573a7 Mon Sep 17 00:00:00 2001
From: John Mulligan <jmulligan@redhat.com>
Date: Mon, 16 Dec 2019 14:25:36 -0500
Subject: [PATCH] rbd: improve doc comment style for ListChildren

Signed-off-by: John Mulligan <jmulligan@redhat.com>
---
 rbd/rbd.go | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/rbd/rbd.go b/rbd/rbd.go
index 6935362..80e9581 100644
--- a/rbd/rbd.go
+++ b/rbd/rbd.go
@@ -686,7 +686,10 @@ func (image *Image) Flatten() error {
 	return GetError(C.rbd_flatten(image.image))
 }
 
-// ssize_t rbd_list_children(rbd_image_t image, char *pools, size_t *pools_len,
+// ListChildren returns a list of images that reference the current snapshot.
+//
+// Implements:
+//  ssize_t rbd_list_children(rbd_image_t image, char *pools, size_t *pools_len,
 //               char *images, size_t *images_len);
 func (image *Image) ListChildren() (pools []string, images []string, err error) {
 	if err := image.validate(imageIsOpen); err != nil {