#672: docs: improve finishedEpoch/finishNoActivateEpoch

DARMA-tasking · Jun 21, 2020 · 20aeac9 · 20aeac9
1 parent b86d5d5
commit 20aeac9
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/src/vt/termination/termination.h b/src/vt/termination/termination.h
@@ -343,8 +343,8 @@ struct TerminationDetector :
   );
 
   /**
-   * \brief Tell the termination detector that all work has been enqueued for a
-   * given epoch
+   * \brief Tell the termination detector that all initial work has been
+   * enqueued for a given epoch on this node
    *
    * \param[in] epoch the finished epoch
    */
@@ -358,7 +358,8 @@ struct TerminationDetector :
   void activateEpoch(EpochType const& epoch);
 
   /**
-   * \internal \brief Finish an epoch without activation it
+   * \internal \brief Finish an epoch without activating it (starting the work
+   * of detecting its termination)
    *
    * \param[in] epoch the epoch that is finished
    */