From 1942c6b1f7e1b2d95a1f3b545328259030788d98 Mon Sep 17 00:00:00 2001
From: Arkadiusz Szczepkowicz <arek.szczepkowicz@ng-analytics.com>
Date: Wed, 24 Aug 2022 13:14:48 +0200
Subject: [PATCH] #1899: Improve methods description in runnable.h

---
 src/vt/runnable/runnable.h | 56 ++++++++++++++++++++++++++++++--------
 1 file changed, 44 insertions(+), 12 deletions(-)

diff --git a/src/vt/runnable/runnable.h b/src/vt/runnable/runnable.h
index 6ad9786b8e..404f5ce6af 100644
--- a/src/vt/runnable/runnable.h
+++ b/src/vt/runnable/runnable.h
@@ -207,33 +207,33 @@ struct RunnableNew {
 
 private:
   /**
-   * \internal \brief Loop through all the contexts associated with this
-   * runnable and invoke \c begin() on them.
+   * \internal \brief Call \c begin() on all contexts associated with this
+   * runnable
    */
   void begin();
 
   /**
-   * \internal \brief Loop through all the contexts associated with this
-   * runnable and invoke \c end() on them.
+   * \internal \brief Call \c end() on all contexts associated with this
+   * runnable
    */
   void end();
 
   /**
-   * \internal \brief Loop through all the contexts associated with this
-   * runnable and invoke \c suspend() on them.
+   * \internal \brief Call \c suspend() on all contexts associated with this
+   * runnable
    */
   void suspend();
 
   /**
-   * \internal \brief Loop through all the contexts associated with this
-   * runnable and invoke \c resume() on them.
+   * \internal \brief Call \c resume() on all contexts associated with this
+   * runnable
    */
   void resume();
 
 public:
   /**
-   * \brief Loop through all contexts add run the \c send() method associated
-   * with this runnable
+   * \brief Call \c send() on all contexts associated with this
+   * runnable
    *
    * \param[in] dest the destination element for the send
    * \param[in] bytes the message size
@@ -294,16 +294,48 @@ struct RunnableNew {
 
 private:
 
+#if vt_check_enabled(trace_enabled)
   /**
-   * \internal \brief Store context passed in as parameter in a private member
+   * \internal \brief Store the context pointer in a private member
+   *
+   * \param[in] ptr the Trace context
    */
-#if vt_check_enabled(trace_enabled)
   void addContext(CtxTracePtr&& ptr);
 #endif
+
+  /**
+   * \internal \brief Store the context pointer in a private member
+   *
+   * \param[in] ptr the Continuation context
+   */
   void addContext(CtxContinuationPtr&& ptr);
+
+  /**
+   * \internal \brief Store the context pointer in a private member
+   *
+   * \param[in] ptr the LB data context
+   */
   void addContext(CtxLBDataPtr&& ptr);
+
+  /**
+   * \internal \brief Store the context pointer in a private member
+   *
+   * \param[in] ptr the SetContext context
+   */
   void addContext(CtxSetContextPtr&& ptr);
+
+  /**
+   * \internal \brief Store the context pointer in a private member
+   *
+   * \param[in] ptr the TD context
+   */
   void addContext(CtxTDPtr&& ptr);
+
+  /**
+   * \internal \brief Store the context pointer in a private member
+   *
+   * \param[in] ptr the Collection context
+   */
   void addContext(CtxCollectionPtr&& ptr);
 
 private: