Skip to content

Commit

Permalink
Add docs to CaptureTimeTools
Browse files Browse the repository at this point in the history
  • Loading branch information
OperatorComputer authored and OperatorComputer committed Aug 29, 2024
1 parent b73b11a commit c1190c1
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions src/main/java/us/ihmc/tools/CaptureTimeTools.java
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}
}

0 comments on commit c1190c1

Please sign in to comment.