Merge branch '178-doxygen-mutex' into develop

Author: HerbertKoelman

README.md

@@ -1,6 +1,6 @@
 ### What it does
 
-[![Build Status](https://travis-ci.com/HerbertKoelman/cpp-pthread.svg?branch=master)](https://travis-ci.com/HerbertKoelman/cpp-pthread) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=HerbertKoelman_cpp-pthread&metric=alert_status)](https://sonarcloud.io/dashboard?id=HerbertKoelman_cpp-pthread)  [![codecov](https://codecov.io/gh/HerbertKoelman/cpp-pthread/branch/master/graph/badge.svg)](https://codecov.io/gh/HerbertKoelman/cpp-pthread)
+[![Build Status](https://travis-ci.com/HerbertKoelman/cpp-pthread.svg?branch=master)](https://travis-ci.com/HerbertKoelman/cpp-pthread) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=HerbertKoelman_cpp-pthread&metric=alert_status)](https://sonarcloud.io/dashboard?id=HerbertKoelman_cpp-pthread) [![codecov](https://codecov.io/gh/HerbertKoelman/cpp-pthread/branch/master/graph/badge.svg)](https://codecov.io/gh/HerbertKoelman/cpp-pthread)
 
 Some C/C++ compilers are not implementing all of C++11 and above standard, it's often lacking the concurrency features that the standard brings. These compilers will at some point be updated. I was therefore looking for a way to reduce the effort of switching from a specific implementation to the C++11 standard one.
 

include/pthread/mutex.hpp

@@ -38,44 +38,60 @@ namespace pthread {
         friend class condition_variable;
 
     public:
-        /**
-         The mutex object is locked (by calling pthread_mutex_lock). If the mutex is already locked, the calling thread blocks until the mutex becomes
-         available. This operation returns with the mutex object referenced by mutex in the locked state with the calling thread as its owner.
-         @throw mutex_exception if error conditions preventing this method to succeed.
+        /** Lock the mutex.
+         *
+         * The mutex object is locked (by calling pthread_mutex_lock). If the mutex is already locked, the calling thread blocks until the mutex becomes
+         * available. This operation returns with the mutex object referenced by mutex in the locked state with the calling thread as its owner.
+         *
+         * @throw mutex_exception if error conditions preventing this method to succeed.
+         * @see unlock
+         * @see pthread_mutex_lock
          */
         void lock();
 
-        /**
+        /** Try to lock the mutex.
+         *
          * Identical to lock method except that if the mutex object is currently locked (by any thread, including the
          * current thread), the call returns immediately.
          *
          * @return true if the mutex is locked, false is returned if the lock is held by some other thread.
          * @throw mutex_exception if error conditions preventing this method to succeed.
          * @see lock
          * @see unlock
+         * @see pthread_mutex_trylock
          */
         bool try_lock();
 
-        /**
-         The pthread_mutex_unlock function releases the mutex object referenced by mutex.  The manner in which a mutex is released is dependent upon the mutex's type attribute. If there are threads blocked on the mutex object referenced by mutex when unlock is called, resulting in the mutex becoming available, the scheduling policy is used to determine which thread shall acquire the mutex.
-         @throw mutex_exception if error conditions preventing this method to succeed.
+        /** Release the mutex.
+         *
+         * Releases the mutex object referenced by mutex.  The manner in which a mutex is released is dependent upon the mutex's
+         * type attribute. If there are threads blocked on the mutex object referenced by mutex when unlock is called,
+         * resulting in the mutex becoming available, the scheduling policy is used to determine which thread shall acquire the mutex.
+         *
+         * @throw mutex_exception if error conditions preventing this method to succeed.
+         * @see pthread_mutex_unlock
          */
         void unlock();
 
-        /**
-         Constructor/Desctructor
-         @throw mutex_exception if error conditions preventing this method to succeed.
+        /** create and initialize a mutex.
+         *
+         * > *WARN* the default mutex attributes are used.
+         * 
+         * @throw mutex_exception if error conditions preventing this method to succeed.
+         * @see pthread_mutex_init
          */
         mutex();
 
+        /** destroys the mutex.
+         *
+         * @see pthread_mutex_destroy
+         */
+        virtual ~mutex();
+
         /** not copy-assignable, so no copy contructor is needed.
          *
          */
         mutex(const mutex &) = delete;
-        /**
-         * destroys the mutes (pthread_mutex_destroy)
-         */
-        virtual ~mutex();
 
         /** not copy-assignable
          *