emission does not seem to be the correct word here

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

diff --git a/include/simgrid/s4u/Mailbox.hpp b/include/simgrid/s4u/Mailbox.hpp
index 630d238..21e16e2 100644 (file)
--- a/include/simgrid/s4u/Mailbox.hpp
+++ b/include/simgrid/s4u/Mailbox.hpp
@@ -27,6 +27,7 @@ class XBT_PUBLIC Mailbox {
   friend void intrusive_ptr_add_ref(Mailbox*) {}
   /** private function to manage the mailboxes' lifetime (see @ref s4u_raii) */
   friend void intrusive_ptr_release(Mailbox*) {}
+
 public:
   /** private function, do not use. FIXME: make me protected */
   kernel::activity::MailboxImpl* get_impl() { return pimpl_; }
@@ -74,16 +75,16 @@ public:
   /** Return the actor declared as permanent receiver, or nullptr if none **/
   ActorPtr get_receiver();
 
-  /** Creates (but don't start) a data emission to that mailbox */
+  /** Creates (but don't start) a data transmission to that mailbox */
   CommPtr put_init();
-  /** Creates (but don't start) a data emission to that mailbox */
+  /** Creates (but don't start) a data transmission to that mailbox */
   CommPtr put_init(void* data, uint64_t simulated_size_in_bytes);
-  /** Creates and start a data emission to that mailbox */
+  /** Creates and start a data transmission to that mailbox */
   CommPtr put_async(void* data, uint64_t simulated_size_in_bytes);
 
-  /** Blocking data emission */
+  /** Blocking data transmission */
   void put(void* payload, uint64_t simulated_size_in_bytes);
-  /** Blocking data emission with timeout */
+  /** Blocking data transmission with timeout */
   void put(void* payload, uint64_t simulated_size_in_bytes, double timeout);
 
   /** Creates (but don't start) a data reception onto that mailbox */
@@ -97,6 +98,7 @@ public:
   void* get(double timeout);
 
   // Deprecated functions
+#ifndef DOXYGEN
   /** @deprecated Mailbox::set_receiver() */
   XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::set_receiver()") void setReceiver(ActorPtr actor)
   {
@@ -126,6 +128,7 @@ public:
   {
     return by_name(name);
   }
+#endif
 };
 
 }} // namespace simgrid::s4u