[trace] fix SimDag tracing

[simgrid.git] / src / instr / instr_interface.c

diff --git a/src/instr/instr_interface.c b/src/instr/instr_interface.c
index 83ce6be..2249bd1 100644 (file)
--- a/src/instr/instr_interface.c
+++ b/src/instr/instr_interface.c
@@ -37,7 +37,7 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_api, instr, "API");
  *
  *  \param category The name of the new tracing category to be created.
  *
- *  \see TRACE_category_with_color, MSG_task_set_category
+ *  \see TRACE_category_with_color, MSG_task_set_category, SD_task_set_category
  */
 void TRACE_category(const char *category)
 {
@@ -60,7 +60,7 @@ void TRACE_category(const char *category)
  *  \param color The color of the category (see \ref tracing_tracing to
  *  know how to correctly specify the color)
  *
- *  \see MSG_task_set_category
+ *  \see MSG_task_set_category, SD_task_set_category
  */
 void TRACE_category_with_color (const char *category, const char *color)
 {
@@ -230,6 +230,17 @@ static void instr_user_srcdst_variable(double time,
   }
 }
 
+/** \ingroup TRACE_API
+ *  \brief Creates a file with the topology of the platform file used for the simulator.
+ *
+ *  The graph topology will have the following properties: all hosts, links and routers
+ *  of the platform file are mapped to graph nodes; routes are mapped to edges.
+ *  The platform's AS are not represented in the output.
+ *
+ *  \param filename The name of the file that will hold the graph.
+ *
+ *  \return 1 of successful, 0 otherwise.
+ */
 int TRACE_platform_graph_export_graphviz (const char *filename)
 {
   /* returns 1 if successful, 0 otherwise */