Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fix a bunch of errors in the documentation
[simgrid.git] / include / simgrid / s4u / Comm.hpp
index 0f27f0a..4509432 100644 (file)
@@ -84,34 +84,42 @@ public:
 
   /** Specify the data to send.
    *
+   * @beginrst
    * This is way will get actually copied over to the receiver.
-   * That's completely unrelated from the simulated size (given with @ref Comm::set_payload_size()):
+   * That's completely unrelated from the simulated size (given by :cpp:func:`simgrid::s4u::Comm::set_payload_size`):
    * you can send a short buffer in your simulator, that represents a very large message
    * in the simulated world, or the opposite.
+   * @endrst
    */
   CommPtr set_src_data(void* buff);
-  /** Specify the size of the data to send. Not to be mixed with @ref Comm::set_payload_size()
+  /** Specify the size of the data to send (not to be mixed with set_payload_size())
    *
-   * 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 Comm::set_payload_size()):
-   * you can send a short buffer in your simulator, that represents a very large message
-   * in the simulated world, or the opposite.
+   * @beginrst
+   * That's the size of the data to actually copy in the simulator (ie, the data passed with
+   * :cpp:func:`simgrid::s4u::Comm::set_src_data`). That's completely unrelated from the simulated size (given by
+   * :cpp:func:`simgrid::s4u::Comm::set_payload_size`)): you can send a short buffer in your simulator, that represents
+   * a very large message in the simulated world, or the opposite.
+   * @endrst
    */
   CommPtr set_src_data_size(size_t size);
 
-  /* Specify the amount of bytes which exchange should be simulated. Not to be mixed with @ref Comm::set_src_data_size()
+  /** Specify the amount of bytes which exchange should be simulated (not to be mixed with set_src_data_size())
    *
-   * That's the size of the simulated data, that's completely related from the actual data size (given with @ref
-   * Comm::set_src_data_size()).
+   * @beginrst
+   * That's the size of the simulated data, that's completely related from the actual data size (given by
+   * :cpp:func:`simgrid::s4u::Comm::set_src_data_size`).
+   * @endrst
    */
   CommPtr set_payload_size(double bytes);
 
-  /** Specify the data to send and its size. Don't mix the size with @ref Comm::set_payload_size()
+  /** Specify the data to send and its size (not to be mixed with set_payload_size())
    *
+   * @beginrst
    * This is way will get actually copied over to the receiver.
-   * That's completely unrelated from the simulated size (given with @ref Comm::set_payload_size()):
+   * That's completely unrelated from the simulated size (given by :cpp:func:`simgrid::s4u::Comm::set_payload_size`):
    * you can send a short buffer in your simulator, that represents a very large message
    * in the simulated world, or the opposite.
+   * @endrst
    */
   CommPtr set_src_data(void* buff, size_t size);