Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
fiddle with the doc of actors
authorMartin Quinson <martin.quinson@ens-rennes.fr>
Fri, 10 Jan 2020 10:57:31 +0000 (11:57 +0100)
committerMartin Quinson <martin.quinson@ens-rennes.fr>
Wed, 29 Jan 2020 16:16:47 +0000 (17:16 +0100)
docs/source/app_s4u.rst
include/simgrid/s4u/Actor.hpp

index 8b0c009..b209a3c 100644 (file)
@@ -392,12 +392,10 @@ Simulation objects
 
 .. autodoxyclass:: simgrid::s4u::Actor
 
 
 .. autodoxyclass:: simgrid::s4u::Actor
 
-.. doxygentypedef:: ActorPtr
-
 .. doxygentypedef:: aid_t
 
 .. doxygentypedef:: aid_t
 
-Creating actors
----------------
+Basic management
+----------------
 
 .. tabs::
 
 
 .. tabs::
 
@@ -405,15 +403,9 @@ Creating actors
 
       .. code:: C++
 
 
       .. code:: C++
 
-         #include <simgrid/s4u/Engine.hpp>
+         #include <simgrid/s4u/Actor.hpp>
 
 
-      .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::function< void()> &code)
-      .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code)
-      .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code, Args... args)
-      .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::string &function, std::vector< std::string > args)
-
-      .. autodoxymethod:: simgrid::s4u::Actor::init(const std::string &name, s4u::Host *host)
-      .. autodoxymethod:: simgrid::s4u::Actor::start(const std::function< void()> &code)
+      .. doxygentypedef:: ActorPtr
 
    .. group-tab:: Python
 
 
    .. group-tab:: Python
 
@@ -421,8 +413,6 @@ Creating actors
 
          from simgrid import Actor
 
 
          from simgrid import Actor
 
-      .. automethod:: simgrid.Actor.create
-
    .. group-tab:: C
 
       .. code:: C
    .. group-tab:: C
 
       .. code:: C
@@ -434,15 +424,36 @@ Creating actors
 
          Pointer to a constant actor object.
 
 
          Pointer to a constant actor object.
 
+      .. autodoxymethod:: sg_actor_ref(const_sg_actor_t actor)
+      .. autodoxymethod:: sg_actor_unref(const_sg_actor_t actor)
+
+Creating actors
+---------------
+
+.. tabs::
+
+   .. group-tab:: C++
+
+      .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::function< void()> &code)
+      .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code)
+      .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, F code, Args... args)
+      .. autodoxymethod:: simgrid::s4u::Actor::create(const std::string &name, s4u::Host *host, const std::string &function, std::vector< std::string > args)
+
+      .. autodoxymethod:: simgrid::s4u::Actor::init(const std::string &name, s4u::Host *host)
+      .. autodoxymethod:: simgrid::s4u::Actor::start(const std::function< void()> &code)
+
+   .. group-tab:: Python
+
+      .. automethod:: simgrid.Actor.create
+
+   .. group-tab:: C
+
       .. autodoxymethod:: sg_actor_init(const char *name, sg_host_t host)
       .. autodoxymethod:: sg_actor_start(sg_actor_t actor, xbt_main_func_t code, int argc, char **argv)
 
       .. autodoxymethod:: sg_actor_attach(const char *name, void *data, sg_host_t host, xbt_dict_t properties)
       .. autodoxymethod:: sg_actor_detach()
 
       .. autodoxymethod:: sg_actor_init(const char *name, sg_host_t host)
       .. autodoxymethod:: sg_actor_start(sg_actor_t actor, xbt_main_func_t code, int argc, char **argv)
 
       .. autodoxymethod:: sg_actor_attach(const char *name, void *data, sg_host_t host, xbt_dict_t properties)
       .. autodoxymethod:: sg_actor_detach()
 
-      .. autodoxymethod:: sg_actor_ref(const_sg_actor_t actor)
-      .. autodoxymethod:: sg_actor_unref(const_sg_actor_t actor)
-
 Searching specific actors
 -------------------------
 
 Searching specific actors
 -------------------------
 
index 302d6e5..a040274 100644 (file)
@@ -26,7 +26,7 @@ namespace s4u {
 
 /** An actor is an independent stream of execution in your distributed application.
  *
 
 /** An actor is an independent stream of execution in your distributed application.
  *
- * \beginrst
+ * \rst
  * It is located on a (simulated) :cpp:class:`host <simgrid::s4u::Host>`, but can interact
  * with the whole simulated platform.
  *
  * It is located on a (simulated) :cpp:class:`host <simgrid::s4u::Host>`, but can interact
  * with the whole simulated platform.
  *