aboutsummaryrefslogtreecommitdiffstats
path: root/src/utils/get_byte.h
diff options
context:
space:
mode:
authorlloyd <[email protected]>2010-06-21 19:34:55 +0000
committerlloyd <[email protected]>2010-06-21 19:34:55 +0000
commit3f1f7c92953dea2e51e3a31049e2a3a273d76d18 (patch)
tree56f73413dbee1dcc25dbccf904b842cb682d4016 /src/utils/get_byte.h
parent89ae6f4bc2ff25dc5625875e0cb57b78b28a0b6e (diff)
Doxygen
Diffstat (limited to 'src/utils/get_byte.h')
-rw-r--r--src/utils/get_byte.h7
1 files changed, 5 insertions, 2 deletions
diff --git a/src/utils/get_byte.h b/src/utils/get_byte.h
index fce87af83..7eedbd783 100644
--- a/src/utils/get_byte.h
+++ b/src/utils/get_byte.h
@@ -12,8 +12,11 @@
namespace Botan {
-/*
-* Byte Extraction Function
+/**
+* Byte extraction
+* @param byte_num which byte to extract, 0 == highest byte
+* @param input the value to extract from
+* @return byte byte_num of input
*/
template<typename T> inline byte get_byte(u32bit byte_num, T input)
{