diff options
author | lloyd <[email protected]> | 2010-06-15 23:23:49 +0000 |
---|---|---|
committer | lloyd <[email protected]> | 2010-06-15 23:23:49 +0000 |
commit | 76b57a7c4656f0f5759c34efe8bab664b49cd21d (patch) | |
tree | 04d4b4d871606e55bec9bddc8fcb57ddd238d21d /src/mutex/mutex.h | |
parent | bbe5daf0647a2f0953f1d99272b4e8fbf8d3b6b5 (diff) |
More Doxygen updates/fixes
Diffstat (limited to 'src/mutex/mutex.h')
-rw-r--r-- | src/mutex/mutex.h | 23 |
1 files changed, 19 insertions, 4 deletions
diff --git a/src/mutex/mutex.h b/src/mutex/mutex.h index fcb0e9982..f209466d5 100644 --- a/src/mutex/mutex.h +++ b/src/mutex/mutex.h @@ -12,33 +12,48 @@ namespace Botan { -/* +/** * Mutex Base Class */ class Mutex { public: + /** + * Lock the mutex + */ virtual void lock() = 0; + + /** + * Unlock the mutex + */ virtual void unlock() = 0; virtual ~Mutex() {} }; -/* +/** * Mutex Factory */ class Mutex_Factory { public: + /** + * @return newly allocated mutex + */ virtual Mutex* make() = 0; + virtual ~Mutex_Factory() {} }; -/* -* Mutex Holding Class +/** +* Mutex Holding Class for RAII */ class Mutex_Holder { public: + /** + * Hold onto a mutex until we leave scope + * @param m the mutex to lock + */ Mutex_Holder(Mutex* m) : mux(m) { if(!mux) |