#2147: add documentation for added Trace functions

DARMA-tasking · May 16, 2023 · f164f59 · f164f59
1 parent 8835f53
commit f164f59
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/src/vt/trace/trace_lite.h b/src/vt/trace/trace_lite.h
@@ -252,10 +252,20 @@ struct TraceLite  {
     return static_cast<TimeIntegerType>(time * 1e6);
   }
 
+  /**
+   * \brief Get the number of recorded trace events
+   *
+   * \return the number of trace events
+   */
   std::size_t getNumTraceEvents() const {
     return traces_.size();
   }
 
+  /**
+   * @brief Get the last recorded trace event
+   *
+   * @return the last recorded trace event
+   */
   const LogType* getLastTraceEvent() const noexcept {
     return traces_.empty() ? nullptr : &traces_.back();
   }