[skip ci] Doxygen comment for execution_hint_t extended.

Stiffstream · Sep 7, 2023 · 41c8ad5 · 41c8ad5
1 parent 5035f99
commit 41c8ad5
Showing 1 changed file with 10 additions and 3 deletions.
diff --git a/dev/so_5/execution_demand.hpp b/dev/so_5/execution_demand.hpp
@@ -113,11 +113,18 @@ struct execution_demand_t
 // execution_hint_t
 //
 /*!
- * \since
- * v.5.4.0
- *
  * \brief A hint for a dispatcher for execution of event
  * for the concrete execution_demand.
+ *
+ * An instance of execution hint can be in two "states":
+ *
+ * - holds actual event handler. In that case an invocation of
+ *   exec() method will decrement message limit counter and then
+ *   will call the event handler;
+ * - empty. In that case an invocation of exec() method will only
+ *   decrement message limit counter and nothing more.
+ *
+ * \since v.5.4.0
  */
 class execution_hint_t
 {