From fd993126801449d9b510e2829ba06d145ad67e2e Mon Sep 17 00:00:00 2001 From: Loic Dachary Date: Sun, 19 Feb 2017 10:23:17 +0100 Subject: [PATCH] doc: add doxygen help for crush_get_bucket_item_weight Signed-off-by: Loic Dachary --- src/crush/crush.h | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/src/crush/crush.h b/src/crush/crush.h index 234f81b658528..677ff565d148f 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); -- 2.39.5