From f9bc9157a1413e8e363a7cbe4cc5ab19b4efcf22 Mon Sep 17 00:00:00 2001
From: Martin Quinson <martin.quinson@ens-rennes.fr>
Date: Mon, 13 Dec 2021 17:22:54 +0100
Subject: [PATCH] Document my last hack

---
 docs/source/Models.rst | 8 ++++++++
 docs/source/conf.py    | 3 +++
 2 files changed, 11 insertions(+)

diff --git a/docs/source/Models.rst b/docs/source/Models.rst
index f0c6b52780..d175a95315 100644
--- a/docs/source/Models.rst
+++ b/docs/source/Models.rst
@@ -217,6 +217,14 @@ ns-3 model, such as `examples/platforms/dogbone.xml <https://framagit.org/simgri
 Check the file  `examples/cpp/network-ns3/network-ns3.tesh <https://framagit.org/simgrid/simgrid/tree/master/examples/cpp/network-ns3/network-ns3.tesh>`_
 to see which ones are used in our regression tests.
 
+Alternatively, you can manually modify the ns-3 settings by retrieving
+the ns-3 node from any given host with the
+:cpp:func:`simgrid::get_ns3node_from_sghost` function (defined in
+``simgrid/plugins/ns3.hpp``).
+
+.. doxygenfunction:: simgrid::get_ns3node_from_sghost
+
+
 WiFi platforms
 ^^^^^^^^^^^^^^
 
diff --git a/docs/source/conf.py b/docs/source/conf.py
index a0e377824b..1b78ffd40d 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -94,6 +94,9 @@ nitpick_ignore = [
   ('cpp:identifier', 'kernel::resource::NetworkAction'),
   ('cpp:identifier', 'kernel::routing'),
   ('cpp:identifier', 'kernel::routing::NetPoint'),
+  ('cpp:identifier', 'ns3'),
+  ('cpp:identifier', 'ns3::Ptr<ns3::Node>'),
+  ('cpp:identifier', 'ns3::Node'),
   ('cpp:identifier', 's4u'),
   ('cpp:identifier', 's4u_Actor'),
   ('cpp:identifier', 's4u_Barrier'),
-- 
2.20.1