aboutsummaryrefslogtreecommitdiffstats
path: root/src/utils
diff options
context:
space:
mode:
authorlloyd <[email protected]>2010-11-02 12:33:16 +0000
committerlloyd <[email protected]>2010-11-02 12:33:16 +0000
commit4a361f699573ed3ff128ecc9c654863cd55aaa79 (patch)
tree4e8d4a29abdc937b5dce2c363519429f949e06be /src/utils
parent05edb9f3e52ce18d0833d612fcfebf1442f859ea (diff)
Doxygen
Diffstat (limited to 'src/utils')
-rw-r--r--src/utils/dyn_load/dyn_load.h5
-rw-r--r--src/utils/rotate.h13
2 files changed, 15 insertions, 3 deletions
diff --git a/src/utils/dyn_load/dyn_load.h b/src/utils/dyn_load/dyn_load.h
index c8fb31cf0..b37a52e84 100644
--- a/src/utils/dyn_load/dyn_load.h
+++ b/src/utils/dyn_load/dyn_load.h
@@ -1,4 +1,4 @@
-/**
+/*
* Dynamically Loaded Object
* (C) 2010 Jack Lloyd
*
@@ -12,6 +12,9 @@
namespace Botan {
+/**
+* Represents a DLL or shared object
+*/
class Dynamically_Loaded_Library
{
public:
diff --git a/src/utils/rotate.h b/src/utils/rotate.h
index 5e3eef304..465746e0b 100644
--- a/src/utils/rotate.h
+++ b/src/utils/rotate.h
@@ -12,14 +12,23 @@
namespace Botan {
-/*
-* Word Rotation Functions
+/**
+* Bit rotation left
+* @param input the input word
+* @param rot the number of bits to rotate
+* @return input rotated left by rot bits
*/
template<typename T> inline T rotate_left(T input, size_t rot)
{
return static_cast<T>((input << rot) | (input >> (8*sizeof(T)-rot)));;
}
+/**
+* Bit rotation right
+* @param input the input word
+* @param rot the number of bits to rotate
+* @return input rotated right by rot bits
+*/
template<typename T> inline T rotate_right(T input, size_t rot)
{
return static_cast<T>((input >> rot) | (input << (8*sizeof(T)-rot)));