From: Martin Quinson <martin.quinson@loria.fr>
Date: Sun, 19 Aug 2018 13:11:11 +0000 (+0200)
Subject: 'friend' keyworld is ok for the doc tooling as long as it's fully qualified
X-Git-Tag: v3_21~237
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/9a0588c059ef10ae0f4470e21c6b226b959ea859

'friend' keyworld is ok for the doc tooling as long as it's fully qualified

See https://github.com/sphinx-doc/sphinx/issues/5316
---

diff --git a/include/simgrid/s4u/Activity.hpp b/include/simgrid/s4u/Activity.hpp
index cb8bcc8e24..8c08594ae6 100644
--- a/include/simgrid/s4u/Activity.hpp
+++ b/include/simgrid/s4u/Activity.hpp
@@ -28,17 +28,15 @@ namespace s4u {
  * - Synchronization activities may possibly be connected to no action.
  */
 class XBT_PUBLIC Activity {
-#ifndef DOXYGEN
-  friend Comm;
+  friend simgrid::s4u::Comm;
   friend XBT_PUBLIC void intrusive_ptr_release(Comm * c);
   friend XBT_PUBLIC void intrusive_ptr_add_ref(Comm * c);
-  friend Exec;
+  friend simgrid::s4u::Exec;
   friend XBT_PUBLIC void intrusive_ptr_release(Exec * e);
   friend XBT_PUBLIC void intrusive_ptr_add_ref(Exec * e);
-  friend Io;
+  friend simgrid::s4u::Io;
   friend XBT_PUBLIC void intrusive_ptr_release(Io* i);
   friend XBT_PUBLIC void intrusive_ptr_add_ref(Io* i);
-#endif
 
 protected:
   Activity()  = default;
diff --git a/include/simgrid/s4u/Actor.hpp b/include/simgrid/s4u/Actor.hpp
index 2d2c7e5346..dcab10ea80 100644
--- a/include/simgrid/s4u/Actor.hpp
+++ b/include/simgrid/s4u/Actor.hpp
@@ -121,12 +121,11 @@ namespace s4u {
 
 /** @brief Simulation Agent */
 class XBT_PUBLIC Actor : public simgrid::xbt::Extendable<Actor> {
-#ifndef DOXYGEN
-  friend Exec;
-  friend Mailbox;
+  friend simgrid::s4u::Exec;
+  friend simgrid::s4u::Mailbox;
   friend simgrid::kernel::actor::ActorImpl;
   friend simgrid::kernel::activity::MailboxImpl;
-#endif
+
   kernel::actor::ActorImpl* pimpl_ = nullptr;
 
   explicit Actor(smx_actor_t pimpl) : pimpl_(pimpl) {}
diff --git a/include/simgrid/s4u/Comm.hpp b/include/simgrid/s4u/Comm.hpp
index 71a38a8f84..4eef82f2fe 100644
--- a/include/simgrid/s4u/Comm.hpp
+++ b/include/simgrid/s4u/Comm.hpp
@@ -23,7 +23,7 @@ class XBT_PUBLIC Comm : public Activity {
 public:
   friend XBT_PUBLIC void intrusive_ptr_release(simgrid::s4u::Comm * c);
   friend XBT_PUBLIC void intrusive_ptr_add_ref(simgrid::s4u::Comm * c);
-  friend Mailbox; // Factory of comms
+  friend simgrid::s4u::Mailbox; // Factory of comms
 
   virtual ~Comm();
 
diff --git a/include/simgrid/s4u/ConditionVariable.hpp b/include/simgrid/s4u/ConditionVariable.hpp
index e2f5cce6c1..f4fb4776fb 100644
--- a/include/simgrid/s4u/ConditionVariable.hpp
+++ b/include/simgrid/s4u/ConditionVariable.hpp
@@ -23,10 +23,9 @@ namespace s4u {
  */
 class XBT_PUBLIC ConditionVariable {
 private:
-#ifndef DOXYGEN
-  friend kernel::activity::ConditionVariableImpl;
+  friend simgrid::kernel::activity::ConditionVariableImpl;
   smx_cond_t cond_;
-#endif
+
   explicit ConditionVariable(smx_cond_t cond) : cond_(cond) {}
 public:
   ConditionVariable(ConditionVariable const&) = delete;
diff --git a/include/simgrid/s4u/Host.hpp b/include/simgrid/s4u/Host.hpp
index 26568e8b1d..164da062a7 100644
--- a/include/simgrid/s4u/Host.hpp
+++ b/include/simgrid/s4u/Host.hpp
@@ -35,10 +35,8 @@ namespace s4u {
  * and actors can retrieve the host on which they run using simgrid::s4u::Host::current().
  */
 class XBT_PUBLIC Host : public simgrid::xbt::Extendable<Host> {
-#ifndef DOXYGEN
   friend simgrid::vm::VMModel;            // Use the pimpl_cpu to compute the VM sharing
   friend simgrid::vm::VirtualMachineImpl; // creates the the pimpl_cpu
-#endif
 
 public:
   explicit Host(std::string name);
diff --git a/include/simgrid/s4u/Io.hpp b/include/simgrid/s4u/Io.hpp
index 72b5ea2296..b47c7e7fe0 100644
--- a/include/simgrid/s4u/Io.hpp
+++ b/include/simgrid/s4u/Io.hpp
@@ -29,7 +29,7 @@ private:
 public:
   friend XBT_PUBLIC void intrusive_ptr_release(simgrid::s4u::Io* i);
   friend XBT_PUBLIC void intrusive_ptr_add_ref(simgrid::s4u::Io* i);
-  friend Storage; // Factory of IOs
+  friend simgrid::s4u::Storage; // Factory of IOs
 
   ~Io() = default;
 
diff --git a/include/simgrid/s4u/Link.hpp b/include/simgrid/s4u/Link.hpp
index c6dd56d3d1..bd4a84bac9 100644
--- a/include/simgrid/s4u/Link.hpp
+++ b/include/simgrid/s4u/Link.hpp
@@ -22,9 +22,7 @@ namespace simgrid {
 namespace s4u {
 /** @brief A Link represents the network facilities between [hosts](@ref simgrid::s4u::Host) */
 class XBT_PUBLIC Link : public simgrid::xbt::Extendable<Link> {
-#ifndef DOXYGEN
   friend simgrid::kernel::resource::LinkImpl;
-#endif
 
   // Links are created from the NetZone, and destroyed by their private implementation when the simulation ends
   explicit Link(kernel::resource::LinkImpl* pimpl) : pimpl_(pimpl) {}
diff --git a/include/simgrid/s4u/Mailbox.hpp b/include/simgrid/s4u/Mailbox.hpp
index ebc45a4317..5fbcf2f7f7 100644
--- a/include/simgrid/s4u/Mailbox.hpp
+++ b/include/simgrid/s4u/Mailbox.hpp
@@ -116,10 +116,8 @@ namespace s4u {
  *
  */
 class XBT_PUBLIC Mailbox {
-#ifndef DOXYGEN
-  friend Comm;
+  friend simgrid::s4u::Comm;
   friend simgrid::kernel::activity::MailboxImpl;
-#endif
 
   simgrid::kernel::activity::MailboxImpl* pimpl_;
 
diff --git a/include/simgrid/s4u/Mutex.hpp b/include/simgrid/s4u/Mutex.hpp
index ae785f4841..e81c81555d 100644
--- a/include/simgrid/s4u/Mutex.hpp
+++ b/include/simgrid/s4u/Mutex.hpp
@@ -29,10 +29,9 @@ class ConditionVariable;
  *
  */
 class XBT_PUBLIC Mutex {
-#ifndef DOXYGEN
-  friend ConditionVariable;
+  friend simgrid::s4u::ConditionVariable;
   friend simgrid::kernel::activity::MutexImpl;
-#endif
+
   simgrid::kernel::activity::MutexImpl* pimpl_;
   explicit Mutex(simgrid::kernel::activity::MutexImpl* mutex) : pimpl_(mutex) {}
 
diff --git a/include/simgrid/s4u/NetZone.hpp b/include/simgrid/s4u/NetZone.hpp
index ab145b9de4..8156699c38 100644
--- a/include/simgrid/s4u/NetZone.hpp
+++ b/include/simgrid/s4u/NetZone.hpp
@@ -25,9 +25,7 @@ namespace s4u {
  */
 class XBT_PUBLIC NetZone {
 protected:
-#ifndef DOXYGEN
   friend simgrid::kernel::routing::NetZoneImpl;
-#endif
 
   explicit NetZone(kernel::routing::NetZoneImpl* impl);
   ~NetZone();
diff --git a/include/simgrid/s4u/Storage.hpp b/include/simgrid/s4u/Storage.hpp
index 85005c1259..b6ec31fd4c 100644
--- a/include/simgrid/s4u/Storage.hpp
+++ b/include/simgrid/s4u/Storage.hpp
@@ -27,11 +27,9 @@ XBT_ATTRIB_DEPRECATED_v322("Please use Engine::get_all_storages()") XBT_PUBLIC v
 /** Storage represent the disk resources, usually associated to a given host */
 
 class XBT_PUBLIC Storage : public simgrid::xbt::Extendable<Storage> {
-#ifndef DOXYGEN
-  friend s4u::Engine;
-  friend s4u::Io;
+  friend simgrid::s4u::Engine;
+  friend simgrid::s4u::Io;
   friend simgrid::surf::StorageImpl;
-#endif /* DOXYGEN */
 
 public:
   explicit Storage(std::string name, surf::StorageImpl * pimpl);