Document timer::timing function

Autodesk · Jul 4, 2019 · 62c6c6e · 62c6c6e
1 parent 9b53323
commit 62c6c6e
Showing 1 changed file with 1 addition and 1 deletion.
diff --git 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.