From: Loic Dachary <ldachary@redhat.com>
Date: Sun, 19 Feb 2017 09:23:17 +0000 (+0100)
Subject: doc: add doxygen help for crush_get_bucket_item_weight
X-Git-Tag: v12.0.1~297^2~1
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=fd993126801449d9b510e2829ba06d145ad67e2e;p=ceph.git

doc: add doxygen help for crush_get_bucket_item_weight

Signed-off-by: Loic Dachary <ldachary@redhat.com>
---

diff --git a/src/crush/crush.h b/src/crush/crush.h
index 234f81b6585..677ff565d14 100644
--- a/src/crush/crush.h
+++ b/src/crush/crush.h
@@ -376,6 +376,17 @@ struct crush_map {
 
 
 /* crush.c */
+/** @ingroup API
+ *
+ * Return the 16.16 fixed point weight of the item at __pos__ (zero
+ * based index) within the bucket __b__. If __pos__ is negative or
+ * greater or equal to the number of items in the bucket, return 0.
+ *
+ * @param b the bucket containing items
+ * @param pos the zero based index of the item
+ *
+ * @returns the 16.16 fixed point item weight
+ */
 extern int crush_get_bucket_item_weight(const struct crush_bucket *b, int pos);
 extern void crush_destroy_bucket_uniform(struct crush_bucket_uniform *b);
 extern void crush_destroy_bucket_list(struct crush_bucket_list *b);