#2275: Document new functions in PerfTestHarness

DARMA-tasking · May 6, 2024 · 0b1b04b · 0b1b04b
1 parent f75cf09
commit 0b1b04b
Showing 1 changed file with 11 additions and 4 deletions.
diff --git a/tests/perf/common/test_harness.h b/tests/perf/common/test_harness.h
@@ -167,11 +167,18 @@ struct PerfTestHarness : TestHarnessBase {
    */
   void GetMemoryUsage();
 
-  void
-  DisableGlobalTimer();
+/**
+ * \brief Disables the global timer (execution time of VT_PERF_TEST).
+ * Useful for tests that use custom timers.
+ */
+void DisableGlobalTimer();
+
+/**
+ * \brief Returns information whether global timer (execution time of VT_PERF_TEST)
+ * is disabled.
+ */
+bool ShouldOutputGlobalTimer() const;
 
-  bool
-  ShouldOutputGlobalTimer() const;
 
 private:
   std::string OutputMemoryUse() const;