Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
The parenthesis of SG_BEGIN_DECL fools doxygen. Get rid of them
[simgrid.git] / include / xbt / mallocator.h
index 7b76ed8..4575ee8 100644 (file)
@@ -1,6 +1,6 @@
 /* xbt/mallocator.h -- api to recycle allocated objects                     */
 
-/* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2006-2019. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -11,7 +11,7 @@
 #include <xbt/function_types.h>
 #include <xbt/misc.h>
 
-SG_BEGIN_DECL()
+SG_BEGIN_DECL
 
 /** @addtogroup XBT_mallocator
  *  @brief The mallocator system
@@ -19,7 +19,7 @@ SG_BEGIN_DECL()
  *  This section describes the API to a mallocator.
  *  A mallocator allows you to recycle the objects you don't need anymore  instead of freeing them. A mallocator is a
  *  stack which stores the unused objects  or a given type. If you often need to malloc() / free() objects of a certain
- *  type, you should use a mallocator and call \a xbt_mallocator_get() and \a xbt_mallocator_release() instead of
+ *  type, you should use a mallocator and call @a xbt_mallocator_get() and @a xbt_mallocator_release() instead of
  *  malloc() and free().
  *
  *  When you release an object, it is not freed but it is stored into the mallocator (unless the mallocator is full).
@@ -31,7 +31,7 @@ SG_BEGIN_DECL()
  *
  *  @{
  */
-/** \brief Mallocator data type (opaque structure) */
+/** @brief Mallocator data type (opaque structure) */
 typedef struct s_xbt_mallocator *xbt_mallocator_t;
 XBT_PUBLIC xbt_mallocator_t xbt_mallocator_new(int size, pvoid_f_void_t new_f, void_f_pvoid_t free_f,
                                                void_f_pvoid_t reset_f);
@@ -50,5 +50,5 @@ XBT_PUBLIC void xbt_mallocator_release(xbt_mallocator_t mallocator, void* object
 XBT_PUBLIC void xbt_mallocator_initialization_is_done(int protect);
 /** @} */
 
-SG_END_DECL()
+SG_END_DECL
 #endif                          /* _XBT_MALLOCATOR_H */