improve doxygen comments in s4u

[simgrid.git] / include / simgrid / s4u / Mailbox.hpp

diff --git a/include/simgrid/s4u/Mailbox.hpp b/include/simgrid/s4u/Mailbox.hpp
index 827bc8a..9e41dc1 100644 (file)
--- a/include/simgrid/s4u/Mailbox.hpp
+++ b/include/simgrid/s4u/Mailbox.hpp
@@ -6,14 +6,11 @@
 #ifndef SIMGRID_S4U_MAILBOX_HPP
 #define SIMGRID_S4U_MAILBOX_HPP
 
-#include <string>
-
-#include <xbt/base.h>
 #include <xbt/string.hpp>
-
-#include <simgrid/s4u/forward.hpp>
 #include <simgrid/s4u/Actor.hpp>
 
+#include <string>
+
 namespace simgrid {
 namespace s4u {
 
@@ -105,8 +102,10 @@ namespace s4u {
  * @section s4u_mb_api The API
  */
 class XBT_PUBLIC Mailbox {
+#ifndef DOXYGEN
   friend Comm;
   friend simgrid::kernel::activity::MailboxImpl;
+#endif
 
   simgrid::kernel::activity::MailboxImpl* pimpl_;
 
@@ -118,24 +117,15 @@ class XBT_PUBLIC Mailbox {
   friend void intrusive_ptr_release(Mailbox*) {}
 public:
   /** private function, do not use. FIXME: make me protected */
-  kernel::activity::MailboxImpl* getImpl() { return pimpl_; }
-
-  XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::get_name()") const simgrid::xbt::string& getName() const
-  {
-    return get_name();
-  }
-  XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::get_cname()") const char* getCname() const { return get_cname(); }
+  kernel::activity::MailboxImpl* get_impl() { return pimpl_; }
 
   /** @brief Retrieves the name of that mailbox as a C++ string */
   const simgrid::xbt::string& get_name() const;
   /** @brief Retrieves the name of that mailbox as a C string */
   const char* get_cname() const;
 
-  /** Retrieve the mailbox associated to the given C string */
-  static MailboxPtr byName(const char *name);
-
-  /** Retrieve the mailbox associated to the given C++ string */
-  static MailboxPtr byName(std::string name);
+  /** Retrieve the mailbox associated to the given name */
+  static MailboxPtr by_name(std::string name);
 
   /** Returns whether the mailbox contains queued communications */
   bool empty();
@@ -152,22 +142,22 @@ public:
    * its host even before he does a recv(). This models the real behavior of TCP
    * and MPI communications, amongst other.
    */
-  void setReceiver(ActorPtr actor);
+  void set_receiver(ActorPtr actor);
 
   /** Return the actor declared as permanent receiver, or nullptr if none **/
-  ActorPtr getReceiver();
+  ActorPtr get_receiver();
 
   /** Creates (but don't start) a data emission to that mailbox */
   CommPtr put_init();
   /** Creates (but don't start) a data emission to that mailbox */
-  CommPtr put_init(void* data, uint64_t simulatedSizeInBytes);
+  CommPtr put_init(void* data, uint64_t simulated_size_in_bytes);
   /** Creates and start a data emission to that mailbox */
-  CommPtr put_async(void* data, uint64_t simulatedSizeInBytes);
+  CommPtr put_async(void* data, uint64_t simulated_size_in_bytes);
 
   /** Blocking data emission */
-  void put(void* payload, uint64_t simulatedSizeInBytes);
+  void put(void* payload, uint64_t simulated_size_in_bytes);
   /** Blocking data emission with timeout */
-  void put(void* payload, uint64_t simulatedSizeInBytes, double timeout);
+  void put(void* payload, uint64_t simulated_size_in_bytes, double timeout);
 
   /** Creates (but don't start) a data reception onto that mailbox */
   CommPtr get_init();
@@ -175,9 +165,40 @@ public:
   CommPtr get_async(void** data);
 
   /** Blocking data reception */
-  void* get();
+  void* get(); // FIXME: make a typed template version
   /** Blocking data reception with timeout */
   void* get(double timeout);
+
+  // Deprecated functions
+  /** @deprecated Mailbox::set_receiver() */
+  XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::set_receiver()") void setReceiver(ActorPtr actor)
+  {
+    set_receiver(actor);
+  }
+  /** @deprecated Mailbox::get_receiver() */
+  XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::get_receiver()") ActorPtr getReceiver() { return get_receiver(); }
+  /** @deprecated Mailbox::get_name() */
+  XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::get_name()") const simgrid::xbt::string& getName() const
+  {
+    return get_name();
+  }
+  /** @deprecated Mailbox::get_cname() */
+  XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::get_cname()") const char* getCname() const { return get_cname(); }
+  /** @deprecated Mailbox::get_impl() */
+  XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::get_impl()") kernel::activity::MailboxImpl* getImpl()
+  {
+    return get_impl();
+  }
+  /** @deprecated Mailbox::by_name() */
+  XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::by_name()") static MailboxPtr byName(const char* name)
+  {
+    return by_name(name);
+  }
+  /** @deprecated Mailbox::by_name() */
+  XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::by_name()") static MailboxPtr byName(std::string name)
+  {
+    return by_name(name);
+  }
 };
 
 }} // namespace simgrid::s4u