improve doc to avoid mixture between Comm::set_src_data_size() and Activity::set_rema...

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

diff --git a/include/simgrid/s4u/Comm.hpp b/include/simgrid/s4u/Comm.hpp
index 71a38a8..c9016f9 100644 (file)
--- a/include/simgrid/s4u/Comm.hpp
+++ b/include/simgrid/s4u/Comm.hpp
@@ -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);
-  friend Mailbox; // Factory of comms
+  friend simgrid::s4u::Mailbox; // Factory of comms
 
   virtual ~Comm();
 
@@ -44,7 +44,8 @@ public:
 
   Activity* start() override;
   Activity* wait() override;
-  Activity* wait(double timeout) override;
+  Activity* wait_for(double timeout) override;
+  bool test() override;
 
   /** Start the comm, and ignore its result. It can be completely forgotten after that. */
   Activity* detach();
@@ -58,60 +59,76 @@ public:
   /** Sets the maximal communication rate (in byte/sec). Must be done before start */
   Activity* set_rate(double rate);
 
-  /** Specify the data to send */
+  /** Specify the data to send.
+   *
+   * This is way will get actually copied over to the receiver.
+   * That's completely unrelated from the simulated size (given with @ref Activity::set_remaining()):
+   * you can send a short buffer in your simulator, that represents a very large message
+   * in the simulated world, or the opposite.
+   */
   Activity* set_src_data(void* buff);
-  /** Specify the size of the data to send */
+  /** Specify the size of the data to send. Not to be mixed with @ref Activity::set_remaining()
+   *
+   * That's the size of the data to actually copy in the simulator (ie, the data passed with Activity::set_src_data()).
+   * That's completely unrelated from the simulated size (given with @ref Activity::set_remaining()):
+   * you can send a short buffer in your simulator, that represents a very large message
+   * in the simulated world, or the opposite.
+   */
   Activity* set_src_data_size(size_t size);
-  /** Specify the data to send and its size */
+  /** Specify the data to send and its size. Don't mix the size with @ref Activity::set_remaining()
+   *
+   * This is way will get actually copied over to the receiver.
+   * That's completely unrelated from the simulated size (given with @ref Activity::set_remaining()):
+   * you can send a short buffer in your simulator, that represents a very large message
+   * in the simulated world, or the opposite.
+   */
   Activity* set_src_data(void* buff, size_t size);
 
-  /** Specify where to receive the data */
+  /** Specify where to receive the data.
+   *
+   * That's a buffer where the sent data will be copied */
   Activity* set_dst_data(void** buff);
-  /** Specify the buffer in which the data should be received */
+  /** Specify the buffer in which the data should be received
+   *
+   * That's a buffer where the sent data will be copied  */
   Activity* set_dst_data(void** buff, size_t size);
-  /** Retrieve the size of the received data */
+  /** Retrieve the size of the received data. Not to be mixed with @ref Activity::set_remaining()  */
   size_t get_dst_data_size();
 
-  bool test();
   Activity* cancel() override;
 
   /** Retrieve the mailbox on which this comm acts */
   MailboxPtr get_mailbox();
 
-  /** @deprecated See Comm::set_rate() */
+#ifndef DOXYGEN
+  XBT_ATTRIB_DEPRECATED_v324("Please use Comm::wait_for()") void wait(double t) override { wait_for(t); }
   XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_rate()") Activity* setRate(double rate) { return set_rate(rate); }
-  /** @deprecated See Comm::set_src_data() */
   XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data()") Activity* setSrcData(void* buff)
   {
     return set_src_data(buff);
   }
-  /** @deprecated See Comm::set_src_data() */
   XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data()") Activity* setSrcData(void* buff, size_t size)
   {
     return set_src_data(buff, size);
   }
-  /** @deprecated See Comm::set_src_data_size() */
   XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_src_data_size()") Activity* setSrcDataSize(size_t size)
   {
     return set_src_data_size(size);
   }
-  /** @deprecated See Comm::set_dst_data() */
   XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_dst_data()") Activity* setDstData(void** buff)
   {
     return set_dst_data(buff);
   }
-  /** @deprecated See Comm::set_dst_data() */
   XBT_ATTRIB_DEPRECATED_v323("Please use Comm::set_dst_data()") Activity* setDstData(void** buff, size_t size)
   {
     return set_dst_data(buff, size);
   }
-  /** @deprecated See Comm::get_dst_data_size() */
   XBT_ATTRIB_DEPRECATED_v323("Please use Comm::get_dst_data_size()") size_t getDstDataSize()
   {
     return get_dst_data_size();
   }
-  /** @deprecated See Comm::get_mailbox() */
   XBT_ATTRIB_DEPRECATED_v323("Please use Comm::get_mailbox()") MailboxPtr getMailbox() { return get_mailbox(); }
+#endif
 
 private:
   double rate_        = -1;