From f164f59da4eb501c80d184274f0b48e19c94e88c Mon Sep 17 00:00:00 2001 From: Nicolas Morales Date: Tue, 16 May 2023 15:54:55 -0700 Subject: [PATCH] #2147: add documentation for added Trace functions --- src/vt/trace/trace_lite.h | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/vt/trace/trace_lite.h b/src/vt/trace/trace_lite.h index 0e51b93669..e39e4da45c 100644 --- a/src/vt/trace/trace_lite.h +++ b/src/vt/trace/trace_lite.h @@ -252,10 +252,20 @@ struct TraceLite { return static_cast(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(); }