From 5750997d5c7ef0a4fd9b41e0e4ba566d3a3907d2 Mon Sep 17 00:00:00 2001
From: frank <mailbox@shampoo.ooo>
Date: Mon, 4 Dec 2023 23:14:30 -0500
Subject: [PATCH] add doc to sb::Animation::playing

---
 src/Animation.hpp | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/src/Animation.hpp b/src/Animation.hpp
index 067d9c1..9acdcb8 100644
--- a/src/Animation.hpp
+++ b/src/Animation.hpp
@@ -75,7 +75,12 @@ public:
     void pause();
     void unpause();
     void reset();
-    bool playing(bool = true) const;
+
+    /*!
+     * @param include_delay  Specify whether or not to include the delay time in the check
+     * @return               True if the animation is playing
+     */
+    bool playing(bool include_delay = true) const;
 
     /*!
      * Update the timer and check the function's return value to determine whether a new frame of the animation should be produced.