Merge branch 'iss-25' into develop

Author: HerbertKoelman

include/pthread/condition_variable.hpp

@@ -178,7 +178,13 @@ namespace pthread {
    */
   class condition_variable_exception: public pthread_exception {
   public:
-    condition_variable_exception( const string message, const int pthread_error = 0);
+
+    /** thrown when mutex actions fail
+     *
+     * @param message short description
+     * @param pthread_errno error returned by the pthread function
+     */
+    condition_variable_exception( const string message, const int pthread_errno = 0);
     virtual ~condition_variable_exception(){};
   };
 

include/pthread/mutex.hpp

@@ -67,19 +67,21 @@ namespace pthread {
     virtual ~mutex ();
 
   protected:
-    pthread_mutex_t _mutex;
+    /** pthread mutex structure */
+    pthread_mutex_t _mutex; 
   };
 
   /** throw to indicate that something went wrong with a mutex.
    */
   class mutex_exception: public pthread_exception {
   public:
+
     /** thrown when mutex actions fail
      *
      * @param message short description
      * @param pthread_errno error returned by the pthread function
      */
-    mutex_exception( const string message, const int pthread_error = 0) ;
+    mutex_exception( const string message, const int pthread_errno = 0) ;
 
   };
 

include/pthread/pthread.hpp

@@ -31,6 +31,7 @@
 */
 namespace pthread {
 
+  /** @return library version */
   extern "C" const char *cpp_pthread_version();
 
 }

include/pthread/pthread_exception.hpp

@@ -27,7 +27,7 @@ namespace pthread {
      * @param message error message
      * @param pthread_errno a pthread function return code.
      */
-    pthread_exception( const string message, const int pthread_number = 0 ): _message(message), _pthread_errno(pthread_number){};
+    pthread_exception( const string message, const int pthread_errno = 0 ): _message(message), _pthread_errno(pthread_number){};
 
     virtual ~pthread_exception(){};
 
@@ -50,7 +50,10 @@ namespace pthread {
    */
   class timeout_exception: public pthread_exception{
   public:
-    /** thrown when a time out occurs. */
+    /** thrown when a time out occurs.
+     *
+     * @param message timeout condition
+     */
     timeout_exception(const string message): pthread_exception(message, ETIMEDOUT){};
   };
 

include/pthread/thread.hpp

@@ -83,8 +83,8 @@ namespace pthread {
 
 //    /** Starts running given function in a new trhread.
 //     * 
-//     * @param f function to run in thread
-//     * @param args function paramleters/arguments.
+//     * param f function to run in thread
+//     * param args function paramleters/arguments.
 //     */
 //    template<class Function, class... Args> explicit thread(Function&& f, Args&&... args);
 
@@ -272,7 +272,7 @@ namespace pthread {
      */
     virtual ~thread_group();
 
-    /** @param add/register a thread to the group.
+    /** @param thread add/register a thread to the group.
      */
     void add(abstract_thread *thread);
 
@@ -306,6 +306,22 @@ namespace pthread {
     thread_exception(const string message, const int pthread_error = 0);
   };
 
+  /** \namespace pthread::this_thread
+   * 
+   * helper functions
+   */
+  namespace this_thread{
+
+    /** let the current thread sleep for the given milliseconds.
+     *
+     * @param millis time to wait.
+     */
+    void sleep(const int millis);
+    
+    /** @return current thread id/reference */
+    pthread_t get_id() ;
+  }
+
   // template implementations ------
 
 //  // GCC magic
@@ -401,20 +417,6 @@ namespace pthread {
 //    
 //  }
 
-  /** \namespace this_thread
-   * 
-   * helper functions
-   */
-  namespace this_thread{
-
-    /** let the current thread sleep for the given milliseconds.
-     *
-     * @param milis time to wait.
-     */
-    void sleep(const int millis);
-    
-    pthread_t get_id() ;
-  }
 
 } // namespace pthread
 #endif /* thread_hpp */