From 62c6c6e85061d33d08c4797841a97c7048b6d700 Mon Sep 17 00:00:00 2001
From: Rhys Goldstein <rhys.goldstein@autodesk.com>
Date: Thu, 4 Jul 2019 14:48:26 -0400
Subject: [PATCH] Document timer::timing function

---
 src/sydevs/core/timer.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/sydevs/core/timer.h b/src/sydevs/core/timer.h
index 398e86ff..041023b6 100644
--- a/src/sydevs/core/timer.h
+++ b/src/sydevs/core/timer.h
@@ -40,7 +40,7 @@ class timer
     timer& operator=(timer&&)      = default;  ///< Move assignment
     ~timer()                       = default;  ///< Destructor
 
-    bool timing() const;
+    bool timing() const;  ///< Returns `true` if the timer has been started but not yet stopped.
 
     duration cumulative_duration() const;  ///< Returns the cumulative duration of measured time.