Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
simplify dependencies stuff (less accessors)
[simgrid.git] / include / simgrid / forward.h
index 8a2edfb..0690462 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2004-2020. 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. */
@@ -16,6 +16,10 @@ namespace simgrid {
 
 namespace s4u {
 class Activity;
+/** Smart pointer to a simgrid::s4u::Actor */
+typedef boost::intrusive_ptr<Activity> ActivityPtr;
+XBT_PUBLIC void intrusive_ptr_release(const Activity* actor);
+XBT_PUBLIC void intrusive_ptr_add_ref(const Activity* actor);
 
 class Actor;
 /** Smart pointer to a simgrid::s4u::Actor */
@@ -36,7 +40,10 @@ 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 */
+/** @beginrst
+ * Smart pointer to a :cpp:type:`simgrid::s4u::ConditionVariable`
+ * @endrst
+ */
 typedef boost::intrusive_ptr<ConditionVariable> ConditionVariablePtr;
 XBT_PUBLIC void intrusive_ptr_release(const ConditionVariable* c);
 XBT_PUBLIC void intrusive_ptr_add_ref(const ConditionVariable* c);
@@ -68,7 +75,11 @@ class Mailbox;
 class Mutex;
 XBT_PUBLIC void intrusive_ptr_release(const Mutex* m);
 XBT_PUBLIC void intrusive_ptr_add_ref(const Mutex* m);
-/** Smart pointer to a simgrid::s4u::Mutex */
+/**
+ * @beginrst
+ * Smart pointer to a :cpp:type:`simgrid::s4u::Mutex`
+ * @endrst
+ */
 typedef boost::intrusive_ptr<Mutex> MutexPtr;
 
 class NetZone;
@@ -226,7 +237,9 @@ typedef struct s_smx_sem* smx_sem_t;
 
 #endif
 
+/** Pointer to a SimGrid barrier object */
 typedef s4u_Barrier* sg_bar_t;
+/** Constant pointer to a SimGrid barrier object */
 typedef const s4u_Barrier* const_sg_bar_t;
 typedef s4u_ConditionVariable* sg_cond_t;
 typedef const s4u_ConditionVariable* const_sg_cond_t;