improvements to ShareableMutex

- add some docs
- remove unnecessary null checks
- improve field name

Change-Id: I8299ec0d56ee5d903f05f2790f97f90ca00663cb

1 files changed, 8 insertions, 2 deletions

diff --git a/framework/inc/helper/shareablemutex.hxx b/framework/inc/helper/shareablemutex.hxx
index 73c62ab11245..1a3b506906da 100644
--- a/framework/inc/helper/shareablemutex.hxx
+++ b/framework/inc/helper/shareablemutex.hxx
@@ -27,6 +27,9 @@
 namespace framework
 {
 
+/**
+ * This acts like a rtl::Reference<osl::Mutex>
+ */
 class FWI_DLLPUBLIC ShareableMutex
 {
     public:
@@ -34,12 +37,15 @@ class FWI_DLLPUBLIC ShareableMutex
         ShareableMutex( const ShareableMutex& rShareableMutex );
         const ShareableMutex& operator=( const ShareableMutex& rShareableMutex );
 
-        ~ShareableMutex();
+        ~ShareableMutex() { m_pMutexRef->release(); }
 
+        /** acquire the shared mutex */
         void acquire();
+        /** release the shared mutex */
         void release();
 
     private:
+        /* ShareableMutex::MutexRef will destroy itself when the last ShareableMutex pointing to it is destroyed */
         struct MutexRef
         {
             MutexRef() : m_refCount(0) {}
@@ -58,7 +64,7 @@ class FWI_DLLPUBLIC ShareableMutex
             osl::Mutex          m_oslMutex;
         };
 
-        MutexRef* pMutexRef;
+        MutexRef* m_pMutexRef;
 };
 
 class ShareGuard