X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/7def41d1b91df56096d1e45eb161ec2da8a175df..c225312830f146ce85fcd8b48e705fbee707bcb0:/include/simgrid/s4u/Actor.hpp diff --git a/include/simgrid/s4u/Actor.hpp b/include/simgrid/s4u/Actor.hpp index 84d93453fd..017a8a71fd 100644 --- a/include/simgrid/s4u/Actor.hpp +++ b/include/simgrid/s4u/Actor.hpp @@ -240,7 +240,7 @@ public: /** Add a callback fired when an actor terminates its code. * @beginrst * The actor may continue to exist if it is still referenced in the simulation, but it's not active anymore. - * If you want to free extra data when the actor's destructor is called, use :cpp:var:`Actor::on_destruction`. + * If you want to free extra data when the actor's destructor is called, use :cpp:func:`Actor::on_destruction_cb`. * If you want to register to the termination of a given actor, use :cpp:func:`this_actor::on_exit()` instead. * @endrst */ @@ -251,8 +251,9 @@ public: * If you want to register to the termination of a given actor, use this_actor::on_exit() instead.*/ static void on_destruction_cb(const std::function& cb) { on_destruction.connect(cb); } - /** Create an actor from a std::function. - * If the actor is restarted, it gets a fresh copy of the function. */ + /** Create an actor from a @c std::function. + * If the actor is restarted, it gets a fresh copy of the function. + * @verbatim embed:rst:inline See the :ref:`example `. @endverbatim */ static ActorPtr create(const std::string& name, s4u::Host* host, const std::function& code); /** Create an actor, but don't start it yet. * @@ -277,7 +278,8 @@ public: ActorPtr start(const std::function& code, std::vector args); - /** Create an actor from a callable thing. */ + /** Create an actor from a callable thing. + * @verbatim embed:rst:inline See the :ref:`example `. @endverbatim */ template static ActorPtr create(const std::string& name, s4u::Host* host, F code) { return create(name, host, std::function(std::move(code))); @@ -285,7 +287,8 @@ public: /** Create an actor using a callable thing and its arguments. * - * Note that the arguments will be copied, so move-only parameters are forbidden */ + * Note that the arguments will be copied, so move-only parameters are forbidden. + * @verbatim embed:rst:inline See the :ref:`example `. @endverbatim */ template `. @endverbatim */ static ActorPtr create(const std::string& name, s4u::Host* host, const std::string& function, std::vector args);