Merge branch 'torus'

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

diff --git a/src/surf/surf_routing.hpp b/src/surf/surf_routing.hpp
index 7d34cbc..e4d93c6 100644 (file)
--- a/src/surf/surf_routing.hpp
+++ b/src/surf/surf_routing.hpp
@@ -1,4 +1,4 @@
-#include "surf.hpp"
+#include "surf_interface.hpp"
 #include <float.h>
 
 #ifndef NETWORK_ROUTING_HPP_
@@ -14,6 +14,9 @@ xbt_edge_t new_xbt_graph_edge (xbt_graph_t graph, xbt_node_t s, xbt_node_t d, xb
 /***********
  * Classes *
  ***********/
+
+/* Note: As and RoutingEdge are declard as struct instead of class, to keep
+   compatibility with C files where they are mentioned. */
 struct As;
 typedef As *AsPtr;
 
@@ -29,14 +32,10 @@ typedef Onelink *OnelinkPtr;
 class RoutingPlatf;
 typedef RoutingPlatf *RoutingPlatfPtr;
 
-
-/*FIXME:class RoutingModelDescription {
-  const char *p_name;
-  const char *p_desc;
-  AsPtr create();
-  void end(AsPtr as);
-};*/
-
+/** @ingroup SURF_routing_interface
+ * @brief The Autonomous System (AS) routing interface
+ * @details [TODO]
+ */
 struct As {
 public:
   xbt_dynar_t p_indexNetworkElm;
@@ -49,11 +48,27 @@ public:
   RoutingEdgePtr p_netElem;
   xbt_dynar_t p_linkUpDownList;
 
+  /**
+   * @brief The As constructor
+   */
   As(){};
+
+  /**
+   * @brief The As destructor
+   */
   virtual ~As(){
        xbt_free(p_name);
   };
 
+  /**
+   * @brief Get the route and latency between two RoutingEdgs
+   * @details [long description]
+   * 
+   * @param src [description]
+   * @param dst [description]
+   * @param into [description]
+   * @param latency [description]
+   */
   virtual void getRouteAndLatency(RoutingEdgePtr src, RoutingEdgePtr dst, sg_platf_route_cbarg_t into, double *latency)=0;
   virtual xbt_dynar_t getOneLinkRoutes()=0;
   virtual void getGraph(xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges)=0;
@@ -70,6 +85,10 @@ public:
   virtual void parseBypassroute(sg_platf_route_cbarg_t e_route)=0;
 };
 
+/** @ingroup SURF_routing_interface
+ * @brief A routing edge
+ * @details [long description]
+ */
 struct RoutingEdge {
 public:
   ~RoutingEdge() { xbt_free(p_name);};
@@ -79,8 +98,9 @@ public:
   char *p_name;
 };
 
-/*
- * Link of lenght 1, alongside with its source and destination. This is mainly usefull in the bindings to gtnets and ns3
+
+/** @ingroup SURF_routing_interface
+ * @brief Link of lenght 1, alongside with its source and destination. This is mainly usefull in the bindings to gtnets and ns3
  */
 class Onelink {
 public:
@@ -91,8 +111,12 @@ public:
   void *p_link;
 };
 
+/** @ingroup SURF_routing_interface
+ * @brief The class representing a whole routing platform
+ */
 class RoutingPlatf {
 public:
+  ~RoutingPlatf();
   AsPtr p_root;
   void *p_loopback;
   xbt_dynar_t p_lastRoute;