Pointer-to-const (sonar).

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

diff --git a/src/instr/instr_platform.cpp b/src/instr/instr_platform.cpp
index 619cafe..deaa01a 100644 (file)
--- a/src/instr/instr_platform.cpp
+++ b/src/instr/instr_platform.cpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2010-2021. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2010-2022. 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. */
@@ -15,7 +15,7 @@
 
 #include "src/instr/instr_private.hpp"
 #include "src/kernel/resource/CpuImpl.hpp"
-#include "src/kernel/resource/StandardLinkImpl.hpp"
+#include "src/kernel/resource/NetworkModel.hpp"
 #include "src/surf/surf_interface.hpp"
 
 #include <fstream>
@@ -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);