Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
doxygen: uniformity in command markers (@ vs. \)
[simgrid.git] / include / simgrid / kernel / routing / FatTreeZone.hpp
index da365f7..01a560e 100644 (file)
@@ -14,7 +14,7 @@ namespace routing {
 
 class XBT_PRIVATE FatTreeLink;
 
-/** \brief A node in a fat tree (@ref FatTreeZone).
+/** @brief A node in a fat tree (@ref FatTreeZone).
  * A FatTreeNode can either be a switch or a processing node. Switches are
  * identified by a negative ID. This class is closely related to fat
  */
@@ -25,7 +25,7 @@ public:
   /* Level into the tree, with 0 being the leafs.
    */
   unsigned int level;
-  /* \brief Position into the level, starting from 0.
+  /* @brief Position into the level, starting from 0.
    */
   unsigned int position;
   /** In order to link nodes between them, each one must be assigned a label,
@@ -54,7 +54,7 @@ public:
   FatTreeNode(ClusterCreationArgs* cluster, int id, int level, int position);
 };
 
-/** \brief Link in a fat tree (@ref FatTreeZone).
+/** @brief Link in a fat tree (@ref FatTreeZone).
  *
  * Represents a single, duplex link in a fat tree. This is necessary to have a tree.
  * It is equivalent to a physical link.
@@ -102,14 +102,14 @@ public:
   ~FatTreeZone() override;
   void get_local_route(NetPoint* src, NetPoint* dst, RouteCreationArgs* into, double* latency) override;
 
-  /** \brief Generate the fat tree
+  /** @brief Generate the fat tree
    *
    * Once all processing nodes have been added, this will make sure the fat
    * tree is generated by calling generateLabels(), generateSwitches() and
    * then connection all nodes between them, using their label.
    */
   void seal() override;
-  /** \brief Read the parameters in topo_parameters field.
+  /** @brief Read the parameters in topo_parameters field.
    *
    * It will also store the cluster for future use.
    */