Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
improve doc to avoid mixture between Comm::set_src_data_size() and Activity::set_rema...
authorMartin Quinson <martin.quinson@loria.fr>
Thu, 20 Sep 2018 20:59:44 +0000 (22:59 +0200)
committerMartin Quinson <martin.quinson@loria.fr>
Thu, 20 Sep 2018 20:59:44 +0000 (22:59 +0200)
include/simgrid/s4u/Comm.hpp

index ff9c373..c9016f9 100644 (file)
@@ -59,18 +59,40 @@ public:
   /** Sets the maximal communication rate (in byte/sec). Must be done before start */
   Activity* set_rate(double rate);
 
   /** 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);
   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);
   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);
 
   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);
   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);
   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();
 
   Activity* cancel() override;
   size_t get_dst_data_size();
 
   Activity* cancel() override;