finish the API under the new format

[simgrid.git] / include / simgrid / s4u / Exec.hpp

diff --git a/include/simgrid/s4u/Exec.hpp b/include/simgrid/s4u/Exec.hpp
index 3611c54..1bd4230 100644 (file)
--- a/include/simgrid/s4u/Exec.hpp
+++ b/include/simgrid/s4u/Exec.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2017-2019. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2017-2020. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -16,8 +16,18 @@ namespace s4u {
 
 /** Computation Activity, representing the asynchronous executions.
  *
- * They are generated from this_actor::exec_init() or Host::execute(), and can be used to model pools of threads or
- * similar mechanisms.
+ * @rst
+ * 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 occuring in another thread when the calling actor is not blocked during the execution.
+ *
+ * You can also use :cpp:func:`simgrid::s4u::this_actor::parallel_execute()` to create *parallel* executions. These
+ * objects represent distributed computations involving computations on several hosts and communications between them.
+ * Such objects can for example represent a matrix multiplication done with ScaLAPACK on a real system. Once created,
+ * parallel Exec are very similar to the sequential ones. The only difference is that you cannot migrate them, and their
+ * remaining amount of work can only be defined as a ratio. See the doc of :cpp:func:`simgrid::s4u::Exec::get_remaining`
+ * and :cpp:func:`simgrid::s4u::Exec::get_remaining_ratio` for more info.
+ * @endrst
  */
 class XBT_PUBLIC Exec : public Activity_T<Exec> {
   double priority_              = 1.0;
@@ -39,9 +49,11 @@ public:
   static xbt::signal<void(Actor const&, Exec const&)> on_start;
   static xbt::signal<void(Actor const&, Exec const&)> on_completion;
 
-  virtual Exec* start() override          = 0;
-  virtual double get_remaining_ratio()    = 0;
-  virtual ExecPtr set_host(Host* host)    = 0;
+  Exec* start() override               = 0;
+  /** @brief On sequential executions, returns the amount of flops that remain to be done; This cannot be used on
+   * parallel executions. */
+  virtual double get_remaining_ratio() = 0;
+  virtual ExecPtr set_host(Host* host) = 0;
 
   Exec* wait() override;
   Exec* wait_for(double timeout) override;
@@ -55,7 +67,7 @@ public:
 
   ExecPtr set_bound(double bound);
   ExecPtr set_priority(double priority);
-  ExecPtr set_timeout(double timeout);
+  XBT_ATTRIB_DEPRECATED_v329("Please use exec_init(...)->wait_for(timeout)") ExecPtr set_timeout(double timeout);
   Exec* cancel() override;
   Host* get_host() const;
   unsigned int get_host_number() const;