Fix the RST inclusions in doxygen comments

diff --git a/docs/source/Doxyfile b/docs/source/Doxyfile
index 764eb48..538cf22 100644 (file)
--- a/docs/source/Doxyfile
+++ b/docs/source/Doxyfile
@@ -36,7 +36,6 @@ AUTOLINK_SUPPORT       = NO # Don't try to link words that correspond to documen
 
 # Allow for rst directives and advanced functions e.g. grid tables
 ALIASES                = "beginrst=\verbatim embed:rst:leading-asterisk"
-ALIASES               += "rst=\verbatim "
 ALIASES               += "endrst=\endverbatim"
 
 # Enable preprocessing and related preprocessor necessities

diff --git a/include/simgrid/msg.h b/include/simgrid/msg.h
index eb4f17a..7304115 100644 (file)
--- a/include/simgrid/msg.h
+++ b/include/simgrid/msg.h
@@ -223,9 +223,9 @@ XBT_PUBLIC void MSG_process_unref(const_sg_actor_t process);
 
 /** @brief Object representing an ongoing communication between processes.
  *
- * \rst
+ * @beginrst
  * Such beast is usually obtained by using :cpp:func:`MSG_task_isend`, :cpp:func:`MSG_task_irecv` or friends.
- * \endrst
+ * @endrst
  */
 typedef sg_msg_Comm* msg_comm_t;
 typedef const sg_msg_Comm* const_msg_comm_t;

diff --git a/include/simgrid/s4u/Actor.hpp b/include/simgrid/s4u/Actor.hpp
index 5a7e590..f26e7e2 100644 (file)
--- a/include/simgrid/s4u/Actor.hpp
+++ b/include/simgrid/s4u/Actor.hpp
@@ -24,7 +24,7 @@ namespace s4u {
 
 /** An actor is an independent stream of execution in your distributed application.
  *
- * \rst
+ * @beginrst
  * It is located on a (simulated) :cpp:class:`host <simgrid::s4u::Host>`, but can interact
  * with the whole simulated platform.
  *
@@ -37,7 +37,8 @@ namespace s4u {
  * The `documentation of this standard <http://en.cppreference.com/w/cpp/thread>`_
  * may help to understand the philosophy of the SimGrid actors.
  *
- * \endrst */
+ * @endrst
+ */
 class XBT_PUBLIC Actor : public xbt::Extendable<Actor> {
 #ifndef DOXYGEN
   friend Exec;
@@ -275,7 +276,7 @@ XBT_PUBLIC void execute(double flop, double priority);
 
 /** Block the current actor until the built parallel execution terminates
  *
- * \rst
+ * @beginrst
  * .. _API_s4u_parallel_execute:
  *
  * **Example of use:** `examples/cpp/exec-ptask/s4u-exec-ptask.cpp
@@ -322,7 +323,7 @@ XBT_PUBLIC void execute(double flop, double priority);
  * models, and you must :ref:`use the ptask_L07 host model <options_model_select>` for that. Note that you can mix
  * regular executions and communications with parallel executions, provided that the host model is ptask_L07.
  *
- * \endrst
+ * @endrst
  */
 /** Block the current actor until the built parallel execution completes */
 XBT_PUBLIC void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,

diff --git a/include/simgrid/s4u/ConditionVariable.hpp b/include/simgrid/s4u/ConditionVariable.hpp
index 558b5cd..f4903c0 100644 (file)
--- a/include/simgrid/s4u/ConditionVariable.hpp
+++ b/include/simgrid/s4u/ConditionVariable.hpp
@@ -17,7 +17,7 @@ namespace simgrid {
 namespace s4u {
 
 /**
- * @rst
+ * @beginrst
  * SimGrid's condition variables are meant to be drop-in replacements of ``std::condition_variable``.
  * Please refer to the `documentation of standard C++ <https://en.cppreference.com/w/cpp/thread/condition_variable>`_
  * for more information on condition variables. A SimGrid example is available in Section :ref:`s4u_ex_IPC`.
@@ -41,7 +41,7 @@ public:
 
   /** Create a new condition variable and return a smart pointer
    *
-   * @rst
+   * @beginrst
    * You should only manipulate :cpp:type:`simgrid::s4u::ConditionVariablePtr`, as created by this function (see also :ref:`s4u_raii`).
    * @endrst
    */

diff --git a/include/simgrid/s4u/Exec.hpp b/include/simgrid/s4u/Exec.hpp
index a5d1079..566d601 100644 (file)
--- a/include/simgrid/s4u/Exec.hpp
+++ b/include/simgrid/s4u/Exec.hpp
@@ -16,7 +16,7 @@ namespace s4u {
 
 /** Computation Activity, representing the asynchronous executions.
  *
- * @rst
+ * @beginrst
  * Most of them are created with :cpp:func:`simgrid::s4u::this_actor::exec_init()` or
  * :cpp:func:`simgrid::s4u::Host::execute()`, and represent a classical (sequential) execution. This can be used to
  * simulate some computation occurring in another thread when the calling actor is not blocked during the execution.

diff --git a/include/simgrid/s4u/Link.hpp b/include/simgrid/s4u/Link.hpp
index 451accc..d3f06f4 100644 (file)
--- a/include/simgrid/s4u/Link.hpp
+++ b/include/simgrid/s4u/Link.hpp
@@ -25,7 +25,7 @@ extern template class XBT_PUBLIC xbt::Extendable<s4u::Link>;
 
 namespace s4u {
 /**
- * @rst
+ * @beginrst
  * A Link represents the network facilities between :cpp:class:`hosts <simgrid::s4u::Host>`.
  * @endrst
  */

diff --git a/include/simgrid/s4u/Mutex.hpp b/include/simgrid/s4u/Mutex.hpp
index c0de117..2374795 100644 (file)
--- a/include/simgrid/s4u/Mutex.hpp
+++ b/include/simgrid/s4u/Mutex.hpp
@@ -14,7 +14,7 @@ namespace s4u {
 
 /** @brief A classical mutex, but blocking in the simulation world.
  *
- * @rst
+ * @beginrst
  * It is strictly impossible to use a real mutex, such as
  * `std::mutex <http://en.cppreference.com/w/cpp/thread/mutex>`_
  * or `pthread_mutex_t <http://pubs.opengroup.org/onlinepubs/007908775/xsh/pthread_mutex_lock.html>`_,

diff --git a/include/simgrid/s4u/Semaphore.hpp b/include/simgrid/s4u/Semaphore.hpp
index f529755..f0c8916 100644 (file)
--- a/include/simgrid/s4u/Semaphore.hpp
+++ b/include/simgrid/s4u/Semaphore.hpp
@@ -14,7 +14,7 @@ namespace s4u {
 
 /** @brief A classical semaphore, but blocking in the simulation world
  *
- * @rst
+ * @beginrst
  * It is strictly impossible to use a real semaphore, such as
  * `sem_init <http://pubs.opengroup.org/onlinepubs/9699919799/functions/sem_init.html>`_,
  * because it would block the whole simulation.

diff --git a/src/bindings/java/org/simgrid/msg/ProcessKilledError.java b/src/bindings/java/org/simgrid/msg/ProcessKilledError.java
index 5911aca..97735ce 100644 (file)
--- a/src/bindings/java/org/simgrid/msg/ProcessKilledError.java
+++ b/src/bindings/java/org/simgrid/msg/ProcessKilledError.java
@@ -7,7 +7,7 @@ package org.simgrid.msg;
 
 /** Used internally to interrupt the user code when the process gets killed.
  *
- * \rst
+ * @beginrst
  * You can catch it for cleanups or to debug, but DO NOT BLOCK IT, or your simulation will segfault!
  *
  * .. code-block:: java
@@ -19,7 +19,7 @@ package org.simgrid.msg;
  *      throw e;
  *    }
  *
- * \endrst
+ * @endrst
  */
 
 public class ProcessKilledError extends Error {

diff --git a/src/msg/msg_task.cpp b/src/msg/msg_task.cpp
index 262158f..c22cdc8 100644 (file)
--- a/src/msg/msg_task.cpp
+++ b/src/msg/msg_task.cpp
@@ -220,10 +220,10 @@ msg_task_t MSG_task_create(const char *name, double flop_amount, double message_
  *
  * A constructor for #msg_task_t taking six arguments.
  *
- * \rst
+ * @beginrst
  * See :cpp:func:`void simgrid::s4u::this_actor::parallel_execute(int, s4u::Host**, double*, double*)` for
  * the exact semantic of the parameters.
- * \endrst
+ * @endrst
  *
  * @param name a name for the object. It is for user-level information and can be nullptr.
  * @param host_nb the number of hosts implied in the parallel task.

diff --git a/src/s4u/s4u_Engine.cpp b/src/s4u/s4u_Engine.cpp
index 0cfdc07..bf90ae3 100644 (file)
--- a/src/s4u/s4u_Engine.cpp
+++ b/src/s4u/s4u_Engine.cpp
@@ -76,9 +76,9 @@ double Engine::get_clock()
 /**
  * Creates a new platform, including hosts, links, and the routing table.
  *
- * \rst
+ * @beginrst
  * See also: :ref:`platform`.
- * \endrst
+ * @endrst
  */
 void Engine::load_platform(const std::string& platf) const
 {
@@ -139,9 +139,9 @@ void Engine::register_function(const std::string& name, const kernel::actor::Act
 
 /** Load a deployment file and launch the actors that it contains
  *
- * \rst
+ * @beginrst
  * See also: :ref:`deploy`.
- * \endrst
+ * @endrst
  */
 void Engine::load_deployment(const std::string& deploy) const
 {