doxygen: uniformity in command markers (@ vs. \)

[simgrid.git] / src / include / surf / surf.hpp

diff --git a/src/include/surf/surf.hpp b/src/include/surf/surf.hpp
index 6c7e702..fc415ec 100644 (file)
--- a/src/include/surf/surf.hpp
+++ b/src/include/surf/surf.hpp
@@ -8,20 +8,20 @@
 
 #include "simgrid/forward.h"
 
-/** \ingroup SURF_models
- *  \brief The CPU model object for the physical machine layer
+/** @ingroup SURF_models
+ *  @brief The CPU model object for the physical machine layer
  */
 XBT_PUBLIC_DATA simgrid::surf::CpuModel* surf_cpu_model_pm;
 
-/** \ingroup SURF_models
- *  \brief The CPU model object for the virtual machine layer
+/** @ingroup SURF_models
+ *  @brief The CPU model object for the virtual machine layer
  */
 XBT_PUBLIC_DATA simgrid::surf::CpuModel* surf_cpu_model_vm;
 
 XBT_PUBLIC_DATA simgrid::surf::StorageModel* surf_storage_model;
 
-/** \ingroup SURF_models
- *  \brief The host model
+/** @ingroup SURF_models
+ *  @brief The host model
  *
  *  Note that when you create an API on top of SURF, the host model should be the only one you use
  *  because depending on the platform model, the network model and the CPU model may not exist.
@@ -31,29 +31,29 @@ XBT_PUBLIC_DATA simgrid::surf::HostModel* surf_host_model;
 
 /*** SURF Globals **************************/
 
-/** \ingroup SURF_simulation
- *  \brief Initialize SURF
- *  \param argc argument number
- *  \param argv arguments
+/** @ingroup SURF_simulation
+ *  @brief Initialize SURF
+ *  @param argc argument number
+ *  @param argv arguments
  *
  *  This function has to be called to initialize the common structures. Then you will have to create the environment by
  *  calling  e.g. surf_host_model_init_CM02()
  *
- *  \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
+ *  @see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
  */
 XBT_PUBLIC void surf_init(int* argc, char** argv); /* initialize common structures */
 
-/** \ingroup SURF_simulation
- *  \brief Finish simulation initialization
+/** @ingroup SURF_simulation
+ *  @brief Finish simulation initialization
  *
  *  This function must be called before the first call to surf_solve()
  */
 XBT_PUBLIC void surf_presolve();
 
-/** \ingroup SURF_simulation
- *  \brief Performs a part of the simulation
- *  \param max_date Maximum date to update the simulation to, or -1
- *  \return the elapsed time, or -1.0 if no event could be executed
+/** @ingroup SURF_simulation
+ *  @brief Performs a part of the simulation
+ *  @param max_date Maximum date to update the simulation to, or -1
+ *  @return the elapsed time, or -1.0 if no event could be executed
  *
  *  This function execute all possible events, update the action states  and returns the time elapsed.
  *  When you call execute or communicate on a model, the corresponding actions are not executed immediately but only
@@ -62,19 +62,19 @@ XBT_PUBLIC void surf_presolve();
  */
 XBT_PUBLIC double surf_solve(double max_date);
 
-/** \ingroup SURF_simulation
- *  \brief Return the current time
+/** @ingroup SURF_simulation
+ *  @brief Return the current time
  *
  *  Return the current time in millisecond.
  */
 XBT_PUBLIC double surf_get_clock();
 
-/** \ingroup SURF_simulation
- *  \brief Exit SURF
+/** @ingroup SURF_simulation
+ *  @brief Exit SURF
  *
  *  Clean everything.
  *
- *  \see surf_init()
+ *  @see surf_init()
  */
 XBT_PUBLIC void surf_exit();