More Doxygen updates/fixes

5 files changed, 23 insertions, 8 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)
diff --git a/src/mutex/noop_mutex/mux_noop.h b/src/mutex/noop_mutex/mux_noop.h
index a1bd57858..20989a635 100644
--- a/src/mutex/noop_mutex/mux_noop.h
+++ b/src/mutex/noop_mutex/mux_noop.h
@@ -12,7 +12,7 @@
 
 namespace Botan {
 
-/*
+/**
 * No-Op Mutex Factory
 */
 class Noop_Mutex_Factory : public Mutex_Factory
diff --git a/src/mutex/pthreads/mux_pthr.h b/src/mutex/pthreads/mux_pthr.h
index 27b854265..5cecd09ad 100644
--- a/src/mutex/pthreads/mux_pthr.h
+++ b/src/mutex/pthreads/mux_pthr.h
@@ -12,7 +12,7 @@
 
 namespace Botan {
 
-/*
+/**
 * Pthread Mutex Factory
 */
 class Pthread_Mutex_Factory : public Mutex_Factory
diff --git a/src/mutex/qt_mutex/mux_qt.h b/src/mutex/qt_mutex/mux_qt.h
index cb396b81d..3805acc3b 100644
--- a/src/mutex/qt_mutex/mux_qt.h
+++ b/src/mutex/qt_mutex/mux_qt.h
@@ -13,7 +13,7 @@
 
 namespace Botan {
 
-/*
+/**
 * Qt Mutex
 */
 class Qt_Mutex_Factory : public Mutex_Factory
diff --git a/src/mutex/win32_crit_section/mux_win32.h b/src/mutex/win32_crit_section/mux_win32.h
index 4bbf6a540..2aa51e18b 100644
--- a/src/mutex/win32_crit_section/mux_win32.h
+++ b/src/mutex/win32_crit_section/mux_win32.h
@@ -13,7 +13,7 @@
 
 namespace Botan {
 
-/*
+/**
 * Win32 Mutex Factory
 */
 class Win32_Mutex_Factory : public Mutex_Factory