From: Martin Quinson <martin.quinson@loria.fr>
Date: Thu, 23 Aug 2018 11:00:11 +0000 (+0200)
Subject: sphinx-compatible declaration of s4u::ActorPtr and co
X-Git-Tag: v3_21~208
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/a3aa914a86e54aa18beb5cbfb892ce8f0d48444e

sphinx-compatible declaration of s4u::ActorPtr and co
---

diff --git a/docs/source/conf.py b/docs/source/conf.py
index 9f69e22d4f..9c9daac2d1 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -65,7 +65,7 @@ exhale_args = {
     # "treeViewIsBootstrap": True,
     "exhaleExecutesDoxygen": True,
     "exhaleDoxygenStdin":    """
-    INPUT = ../../include/simgrid/s4u ../../include/simgrid/xbt
+    INPUT = ../../include/simgrid/s4u ../../include/simgrid/forward.h ../../include/simgrid/xbt
     GENERATE_XML           = YES
     PREDEFINED             += \
         __cplusplus \
diff --git a/include/simgrid/forward.h b/include/simgrid/forward.h
index 0d07099a0c..3661be24db 100644
--- a/include/simgrid/forward.h
+++ b/include/simgrid/forward.h
@@ -16,33 +16,57 @@ namespace simgrid {
 
 namespace s4u {
 class Activity;
+
 class Actor;
-using ActorPtr = boost::intrusive_ptr<Actor>;
+/** Smart pointer to a simgrid::s4u::Actor */
+typedef boost::intrusive_ptr<Actor> ActorPtr;
 XBT_PUBLIC void intrusive_ptr_release(Actor* actor);
 XBT_PUBLIC void intrusive_ptr_add_ref(Actor* actor);
+
 class Barrier;
+
 class Comm;
-using CommPtr = boost::intrusive_ptr<Comm>;
+/** Smart pointer to a simgrid::s4u::Comm */
+typedef boost::intrusive_ptr<Comm> CommPtr;
 XBT_PUBLIC void intrusive_ptr_release(Comm* c);
 XBT_PUBLIC void intrusive_ptr_add_ref(Comm* c);
+
+class ConditionVariable;
+/** Smart pointer to a simgrid::s4u::ConditionVariable */
+typedef boost::intrusive_ptr<ConditionVariable> ConditionVariablePtr;
+XBT_PUBLIC void intrusive_ptr_release(ConditionVariable* c);
+XBT_PUBLIC void intrusive_ptr_add_ref(ConditionVariable* c);
+
 class Engine;
+
 class Exec;
-using ExecPtr = boost::intrusive_ptr<Exec>;
+/** Smart pointer to a simgrid::s4u::Exec */
+typedef boost::intrusive_ptr<Exec> ExecPtr;
 XBT_PUBLIC void intrusive_ptr_release(Exec* e);
 XBT_PUBLIC void intrusive_ptr_add_ref(Exec* e);
+
 class Host;
+
 class Io;
-using IoPtr = boost::intrusive_ptr<Io>;
+/** Smart pointer to a simgrid::s4u::Io */
+typedef boost::intrusive_ptr<Io> IoPtr;
 XBT_PUBLIC void intrusive_ptr_release(Io* i);
 XBT_PUBLIC void intrusive_ptr_add_ref(Io* i);
+
 class Link;
+
 class Mailbox;
-using MailboxPtr = boost::intrusive_ptr<Mailbox>;
+/** Smart pointer to a simgrid::s4u::Mailbox */
+typedef boost::intrusive_ptr<Mailbox> MailboxPtr;
 XBT_PUBLIC void intrusive_ptr_release(Mailbox* m);
 XBT_PUBLIC void intrusive_ptr_add_ref(Mailbox* m);
+
 class Mutex;
 XBT_PUBLIC void intrusive_ptr_release(Mutex* m);
 XBT_PUBLIC void intrusive_ptr_add_ref(Mutex* m);
+/** Smart pointer to a simgrid::s4u::Mutex */
+typedef boost::intrusive_ptr<Mutex> MutexPtr;
+
 class NetZone;
 class VirtualMachine;
 class File;
diff --git a/include/simgrid/s4u/ConditionVariable.hpp b/include/simgrid/s4u/ConditionVariable.hpp
index f4fb4776fb..12e0be189a 100644
--- a/include/simgrid/s4u/ConditionVariable.hpp
+++ b/include/simgrid/s4u/ConditionVariable.hpp
@@ -33,12 +33,14 @@ public:
 
   friend XBT_PUBLIC void intrusive_ptr_add_ref(ConditionVariable * cond);
   friend XBT_PUBLIC void intrusive_ptr_release(ConditionVariable * cond);
-  using Ptr = boost::intrusive_ptr<ConditionVariable>;
 
-  static Ptr create();
+  static ConditionVariablePtr create();
 
   /** @deprecated See Comm::get_mailbox() */
-  XBT_ATTRIB_DEPRECATED_v323("Please use Comm::get_mailbox()") Ptr createConditionVariable() { return create(); }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Comm::get_mailbox()") ConditionVariablePtr createConditionVariable()
+  {
+    return create();
+  }
 
   //  Wait functions without time:
 
@@ -99,7 +101,6 @@ public:
   void notify_all();
 };
 
-using ConditionVariablePtr = ConditionVariable::Ptr;
 }
 } // namespace simgrid::s4u
 
diff --git a/include/simgrid/s4u/Mutex.hpp b/include/simgrid/s4u/Mutex.hpp
index e81c81555d..5feed70146 100644
--- a/include/simgrid/s4u/Mutex.hpp
+++ b/include/simgrid/s4u/Mutex.hpp
@@ -40,8 +40,6 @@ class XBT_PUBLIC Mutex {
   friend XBT_PUBLIC void intrusive_ptr_release(Mutex* mutex);
 
 public:
-  using Ptr = boost::intrusive_ptr<Mutex>;
-
   // No copy:
   /** You cannot create a new mutex by copying an existing one. Use MutexPtr instead */
   Mutex(Mutex const&) = delete;
@@ -49,7 +47,7 @@ public:
   Mutex& operator=(Mutex const&) = delete;
 
   /** Constructs a new mutex */
-  static Ptr create();
+  static MutexPtr create();
 
   void lock();
   void unlock();
@@ -57,11 +55,9 @@ public:
 
   // deprecated
   /** @deprecated Mutex::create() */
-  XBT_ATTRIB_DEPRECATED_v323("Please use Mutex::create()") static Ptr createMutex() { return create(); }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Mutex::create()") static MutexPtr createMutex() { return create(); }
 };
 
-using MutexPtr = Mutex::Ptr;
-
 }} // namespace simgrid::s4u
 
 #endif /* SIMGRID_S4U_MUTEX_HPP */