From c1190c167dd8b34a1ff849947e05cbc325891fb0 Mon Sep 17 00:00:00 2001
From: OperatorComputer <OperatorComputer@unknown>
Date: Thu, 29 Aug 2024 13:43:26 -0500
Subject: [PATCH] Add docs to CaptureTimeTools

---
 src/main/java/us/ihmc/tools/CaptureTimeTools.java | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/src/main/java/us/ihmc/tools/CaptureTimeTools.java b/src/main/java/us/ihmc/tools/CaptureTimeTools.java
index 463f4d7..3f76c74 100644
--- a/src/main/java/us/ihmc/tools/CaptureTimeTools.java
+++ b/src/main/java/us/ihmc/tools/CaptureTimeTools.java
@@ -2,8 +2,14 @@
 
 public class CaptureTimeTools
 {
-   public static long timeSinceStartedCaptureInSeconds(long milliseconds, long startTime)
+   /**
+    * This takes the current time in milliseconds, and returns the seconds that have passed from the start time.
+    * @param currentTimeInMilliSeconds is the current time that you want to compare too
+    * @param startTime is the start time from when capture started
+    * @return the time in seconds that has passed since the start time
+    */
+   public static long timeSinceStartedCaptureInSeconds(long currentTimeInMilliSeconds, long startTime)
    {
-      return 1000 * (milliseconds - startTime);
+      return 1000 * (currentTimeInMilliSeconds - startTime);
    }
 }