Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
doxygen: uniformity in command markers (@ vs. \)
[simgrid.git] / include / xbt / parmap.h
index d8c32f8..69cac53 100644 (file)
@@ -9,20 +9,20 @@
 #ifndef XBT_PARMAP_H
 #define XBT_PARMAP_H
 
-/** \addtogroup XBT_parmap
 * \ingroup XBT_misc
 * \brief Parallel map.
 *
 * A function is applied to all elements of a std::vector in parallel with n worker threads.  The worker threads are
 * persistent until the destruction of the parmap.
 *
 * If there are more than n elements in the vector, the worker threads are allowed to fetch themselves remaining work
 * with method next() and execute it.
 *
 * \{
 */
+/** @addtogroup XBT_parmap
* @ingroup XBT_misc
* @brief Parallel map.
+ *
+ * A function is applied to all elements of a std::vector in parallel with n worker threads.  The worker threads are
+ * persistent until the destruction of the parmap.
+ *
+ * If there are more than n elements in the vector, the worker threads are allowed to fetch themselves remaining work
+ * with method next() and execute it.
+ *
* @{
+ */
 
-/** \brief Synchronization mode of the worker threads of a parmap. */
+/** @brief Synchronization mode of the worker threads of a parmap. */
 typedef enum {
   XBT_PARMAP_POSIX,          /**< use POSIX synchronization primitives */
   XBT_PARMAP_FUTEX,          /**< use Linux futex system call */
@@ -30,6 +30,6 @@ typedef enum {
   XBT_PARMAP_DEFAULT         /**< futex if available, posix otherwise */
 } e_xbt_parmap_mode_t;
 
-/** \} */
+/** @} */
 
 #endif