From e71309302bbae7b43b0148b327b83bdd8fc8fc0d Mon Sep 17 00:00:00 2001 From: schnorr Date: Mon, 26 Mar 2012 15:46:32 +0200 Subject: [PATCH] document xbt graph functions --- src/xbt/graph.c | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/xbt/graph.c b/src/xbt/graph.c index 1d1aa66afc..e7317c34df 100644 --- a/src/xbt/graph.c +++ b/src/xbt/graph.c @@ -81,6 +81,7 @@ xbt_edge_t xbt_graph_new_edge(xbt_graph_t g, return edge; } +/** @brief Get the edge connecting src and dst */ xbt_edge_t xbt_graph_get_edge(xbt_graph_t g, xbt_node_t src, xbt_node_t dst) { @@ -102,21 +103,25 @@ xbt_edge_t xbt_graph_get_edge(xbt_graph_t g, xbt_node_t src, return NULL; } +/** @brief Get the user data associated to a node */ void *xbt_graph_node_get_data(xbt_node_t node) { return node->data; } +/** @brief Set the user data associated to a node */ void xbt_graph_node_set_data(xbt_node_t node, void *data) { node->data = data; } +/** @brief Get the user data associated to a edge */ void *xbt_graph_edge_get_data(xbt_edge_t edge) { return edge->data; } +/** @brief Set the user data associated to a edge */ void xbt_graph_edge_set_data(xbt_edge_t edge, void *data) { edge->data = data; @@ -286,6 +291,7 @@ void xbt_graph_edge_set_length(xbt_edge_t e, double length) } +/** @brief Get the length of a edge */ double xbt_graph_edge_get_length(xbt_edge_t edge) { return edge->length; -- 2.20.1