document a class

[simgrid.git] / src / kernel / context / Context.hpp

diff --git a/src/kernel/context/Context.hpp b/src/kernel/context/Context.hpp
index 89b3833..c184df4 100644 (file)
--- a/src/kernel/context/Context.hpp
+++ b/src/kernel/context/Context.hpp
@@ -81,6 +81,11 @@ namespace context {
     smx_actor_t process_ = nullptr;
   public:
     class StopRequest {
+      /** @brief Exception launched to kill a process, in order to properly unwind its stack and release RAII stuff
+       *
+       * Nope, Sonar, this should not inherit of std::exception.
+       * Otherwise, users may accidentally catch it with a try {} catch (std::exception)
+       */
     };
     bool iwannadie;
 
@@ -158,7 +163,7 @@ XBT_PUBLIC_DATA(char sigsegv_stack[SIGSTKSZ]);
 
 /* We are using the bottom of the stack to save some information, like the
  * valgrind_stack_id. Define smx_context_usable_stack_size to give the remaining
- * size for the stack. Round its value to a multiple of 16 (for stack alignment). */
+ * size for the stack. Round its value to a multiple of 16 (asan wants the stacks to be aligned this way). */
 #if HAVE_VALGRIND_H
 #define smx_context_usable_stack_size                                                                                  \
   ((smx_context_stack_size - sizeof(unsigned int)) & ~0xf) /* for valgrind_stack_id */