Mercurial > hg > ucx / changeset

--- a/src/cx/mempool.h	Sun Jan 05 12:40:43 2025 +0100
+++ b/src/cx/mempool.h	Sun Jan 05 12:41:43 2025 +0100
@@ -26,11 +26,11 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 /**
- * \file mempool.h
- * \brief Interface for memory pool implementations.
- * \author Mike Becker
- * \author Olaf Wintermann
- * \copyright 2-Clause BSD License
+ * @file mempool.h
+ * @brief Interface for memory pool implementations.
+ * @author Mike Becker
+ * @author Olaf Wintermann
+ * @copyright 2-Clause BSD License
  */
 
 #ifndef UCX_MEMPOOL_H
@@ -89,7 +89,7 @@
  *
  * @param capacity the initial capacity of the pool
  * @param destr optional destructor function to use for allocated memory
- * @return the created memory pool or \c NULL if allocation failed
+ * @return the created memory pool or @c NULL if allocation failed
  */
 cx_attr_nodiscard
 cx_attr_malloc
@@ -99,8 +99,8 @@
 /**
  * Creates a basic array-based memory pool.
  *
- * @param capacity the initial capacity of the pool
- * @return the created memory pool or \c NULL if allocation failed
+ * @param capacity (@c size_t) the initial capacity of the pool
+ * @return (@c CxMempool*) the created memory pool or @c NULL if allocation failed
  */
 #define cxBasicMempoolCreate(capacity) cxMempoolCreate(capacity, NULL)
 
@@ -141,7 +141,8 @@
  * @param pool the pool
  * @param memory the object to register (MUST NOT be already allocated in the pool)
  * @param destr the destructor function
- * @return zero on success, non-zero on failure
+ * @retval zero success
+ * @retval non-zero failure
  */
 cx_attr_nonnull
 int cxMempoolRegister(