[SURF] Added simple method comment for AsDijkstra::addLoopback()

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

diff --git a/src/surf/surf_routing_dijkstra.hpp b/src/surf/surf_routing_dijkstra.hpp
index ef68386..033e4f9 100644 (file)
--- a/src/surf/surf_routing_dijkstra.hpp
+++ b/src/surf/surf_routing_dijkstra.hpp
@@ -1,3 +1,9 @@
+/* Copyright (c) 2013-2014. 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. */
+
 #include "surf_routing_generic.hpp"
 
 #ifndef SURF_ROUTING_DIJKSTRA_HPP_
@@ -31,6 +37,18 @@ public:
        xbt_node_t routeGraphNewNode(int id, int graph_id);
        graph_node_map_element_t nodeMapSearch(int id);
        void newRoute(int src_id, int dst_id, sg_platf_route_cbarg_t e_route);
+    /**
+     * For each vertex (node) already in the graph,
+     * make sure it also has a loopback link; this loopback
+     * can potentially already be in the graph, and in that
+     * case nothing will be done.
+     *
+     * If no loopback is specified for a node, we will use
+     * the loopback that is provided by the routing platform.
+     *
+     * After this function returns, any node in the graph
+     * will have a loopback attached to it.
+     */
        void addLoopback();
        void getRouteAndLatency(RoutingEdgePtr src, RoutingEdgePtr dst, sg_platf_route_cbarg_t route, double *lat);
        xbt_dynar_t getOnelinkRoutes();