Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
'friend' keyworld is ok for the doc tooling as long as it's fully qualified
authorMartin Quinson <martin.quinson@loria.fr>
Sun, 19 Aug 2018 13:11:11 +0000 (15:11 +0200)
committerMartin Quinson <martin.quinson@loria.fr>
Sun, 19 Aug 2018 13:11:16 +0000 (15:11 +0200)
See https://github.com/sphinx-doc/sphinx/issues/5316

include/simgrid/s4u/Activity.hpp
include/simgrid/s4u/Actor.hpp
include/simgrid/s4u/Comm.hpp
include/simgrid/s4u/ConditionVariable.hpp
include/simgrid/s4u/Host.hpp
include/simgrid/s4u/Io.hpp
include/simgrid/s4u/Link.hpp
include/simgrid/s4u/Mailbox.hpp
include/simgrid/s4u/Mutex.hpp
include/simgrid/s4u/NetZone.hpp
include/simgrid/s4u/Storage.hpp

index cb8bcc8..8c08594 100644 (file)
@@ -28,17 +28,15 @@ namespace s4u {
  * - Synchronization activities may possibly be connected to no action.
  */
 class XBT_PUBLIC Activity {
  * - 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 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 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);
   friend XBT_PUBLIC void intrusive_ptr_release(Io* i);
   friend XBT_PUBLIC void intrusive_ptr_add_ref(Io* i);
-#endif
 
 protected:
   Activity()  = default;
 
 protected:
   Activity()  = default;
index 2d2c7e5..dcab10e 100644 (file)
@@ -121,12 +121,11 @@ namespace s4u {
 
 /** @brief Simulation Agent */
 class XBT_PUBLIC Actor : public simgrid::xbt::Extendable<Actor> {
 
 /** @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;
   friend simgrid::kernel::actor::ActorImpl;
   friend simgrid::kernel::activity::MailboxImpl;
-#endif
+
   kernel::actor::ActorImpl* pimpl_ = nullptr;
 
   explicit Actor(smx_actor_t pimpl) : pimpl_(pimpl) {}
   kernel::actor::ActorImpl* pimpl_ = nullptr;
 
   explicit Actor(smx_actor_t pimpl) : pimpl_(pimpl) {}
index 71a38a8..4eef82f 100644 (file)
@@ -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);
 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();
 
 
   virtual ~Comm();
 
index e2f5cce..f4fb477 100644 (file)
@@ -23,10 +23,9 @@ namespace s4u {
  */
 class XBT_PUBLIC ConditionVariable {
 private:
  */
 class XBT_PUBLIC ConditionVariable {
 private:
-#ifndef DOXYGEN
-  friend kernel::activity::ConditionVariableImpl;
+  friend simgrid::kernel::activity::ConditionVariableImpl;
   smx_cond_t cond_;
   smx_cond_t cond_;
-#endif
+
   explicit ConditionVariable(smx_cond_t cond) : cond_(cond) {}
 public:
   ConditionVariable(ConditionVariable const&) = delete;
   explicit ConditionVariable(smx_cond_t cond) : cond_(cond) {}
 public:
   ConditionVariable(ConditionVariable const&) = delete;
index 26568e8..164da06 100644 (file)
@@ -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> {
  * 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
   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);
 
 public:
   explicit Host(std::string name);
index 72b5ea2..b47c7e7 100644 (file)
@@ -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);
 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;
 
 
   ~Io() = default;
 
index c6dd56d..bd4a84b 100644 (file)
@@ -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> {
 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;
   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) {}
 
   // Links are created from the NetZone, and destroyed by their private implementation when the simulation ends
   explicit Link(kernel::resource::LinkImpl* pimpl) : pimpl_(pimpl) {}
index ebc45a4..5fbcf2f 100644 (file)
@@ -116,10 +116,8 @@ namespace s4u {
  *
  */
 class XBT_PUBLIC Mailbox {
  *
  */
 class XBT_PUBLIC Mailbox {
-#ifndef DOXYGEN
-  friend Comm;
+  friend simgrid::s4u::Comm;
   friend simgrid::kernel::activity::MailboxImpl;
   friend simgrid::kernel::activity::MailboxImpl;
-#endif
 
   simgrid::kernel::activity::MailboxImpl* pimpl_;
 
 
   simgrid::kernel::activity::MailboxImpl* pimpl_;
 
index ae785f4..e81c815 100644 (file)
@@ -29,10 +29,9 @@ class ConditionVariable;
  *
  */
 class XBT_PUBLIC Mutex {
  *
  */
 class XBT_PUBLIC Mutex {
-#ifndef DOXYGEN
-  friend ConditionVariable;
+  friend simgrid::s4u::ConditionVariable;
   friend simgrid::kernel::activity::MutexImpl;
   friend simgrid::kernel::activity::MutexImpl;
-#endif
+
   simgrid::kernel::activity::MutexImpl* pimpl_;
   explicit Mutex(simgrid::kernel::activity::MutexImpl* mutex) : pimpl_(mutex) {}
 
   simgrid::kernel::activity::MutexImpl* pimpl_;
   explicit Mutex(simgrid::kernel::activity::MutexImpl* mutex) : pimpl_(mutex) {}
 
index ab145b9..8156699 100644 (file)
@@ -25,9 +25,7 @@ namespace s4u {
  */
 class XBT_PUBLIC NetZone {
 protected:
  */
 class XBT_PUBLIC NetZone {
 protected:
-#ifndef DOXYGEN
   friend simgrid::kernel::routing::NetZoneImpl;
   friend simgrid::kernel::routing::NetZoneImpl;
-#endif
 
   explicit NetZone(kernel::routing::NetZoneImpl* impl);
   ~NetZone();
 
   explicit NetZone(kernel::routing::NetZoneImpl* impl);
   ~NetZone();
index 85005c1..b6ec31f 100644 (file)
@@ -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> {
 /** 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;
   friend simgrid::surf::StorageImpl;
-#endif /* DOXYGEN */
 
 public:
   explicit Storage(std::string name, surf::StorageImpl * pimpl);
 
 public:
   explicit Storage(std::string name, surf::StorageImpl * pimpl);