[Bf-blender-cvs] [02ec0b53df0] master: Math utils: Make it more clear what the functions are returning

[Sergey Sharybin]

Commit: 02ec0b53df0a966048500e659389dbb987847c49
Author: Sergey Sharybin
Date:   Fri Dec 15 16:17:37 2017 +0100
Branches: master
https://developer.blender.org/rB02ec0b53df0a966048500e659389dbb987847c49

Math utils: Make it more clear what the functions are returning

===================================================================

M	source/blender/blenlib/BLI_math_bits.h

===================================================================

diff --git a/source/blender/blenlib/BLI_math_bits.h b/source/blender/blenlib/BLI_math_bits.h
index 1d0ee77feed..40a1d84b0e1 100644
--- a/source/blender/blenlib/BLI_math_bits.h
+++ b/source/blender/blenlib/BLI_math_bits.h
@@ -31,6 +31,7 @@ extern "C" {
 
 #include "BLI_math_inline.h"
 
+/* NOTE: Those functions returns 2 to the power of index of highest order bit. */
 MINLINE unsigned int highest_order_bit_uint(unsigned int n);
 MINLINE unsigned short highest_order_bit_s(unsigned short n);