Update Doxygen comments

nschlia · Aug 7, 2024 · e15605e · e15605e
1 parent 01610b9
commit e15605e
Showing 1 changed file with 3 additions and 4 deletions.
diff --git a/src/thread_pool.h b/src/thread_pool.h
@@ -54,7 +54,7 @@
 class thread_pool
 {
 public:
-    typedef std::function<int(void)> FunctionPointer;
+    typedef std::function<int(void)> FunctionPointer; /**< @brief Pointer to thread pool function */
 
 public:
     /**
@@ -81,9 +81,8 @@ class thread_pool
     void            tear_down(bool silent = false);
     /**
      * @brief Schedule a new thread from pool.
-     * @param[in] thread_func - Thread function to start.
-     * @param[in] opaque - Parameter passed to thread function.
-     * @return Returns true if thread was successfully scheduled, fals if not.
+     * @param[in] func - std::function object to call
+     * @return Returns true if thread was successfully scheduled, false if not.
      */
     bool            schedule_thread(FunctionPointer && func);
     /**