Rename example, and update doc.

[simgrid.git] / src / instr / instr_platform.cpp

diff --git a/src/instr/instr_platform.cpp b/src/instr/instr_platform.cpp
index b77017a92c954212fca8d901120b4a252b2bb8e2..d1a1a98fbc8492675fe69d76e7ac1f806eb46fde 100644 (file)
--- a/src/instr/instr_platform.cpp
+++ b/src/instr/instr_platform.cpp
@@ -210,6 +210,11 @@ void instr_new_value_for_user_state_type(const std::string& type_name, const cha
 namespace simgrid {
 namespace instr {
 
+/** @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 zones are not represented in the output.
+ */
 void platform_graph_export_graphviz(const std::string& output_filename)
 {
   auto* g     = xbt_graph_new_graph(0, nullptr);