Cleanup: correct doc-strings for GHOST_GetMilliSeconds

Wayland, macOS & SDL weren't using the start-time of the process.

The start-time offset isn't needed so it's similar to forward the
systems method of accessing the time in milliseconds.
This commit is contained in:
Campbell Barton 2024-01-29 11:47:43 +11:00
parent be7f89a9f5
commit 18eb7e7502
2 changed files with 6 additions and 4 deletions

@ -83,8 +83,8 @@ extern GHOST_TSuccess GHOST_DisposeEventConsumer(GHOST_EventConsumerHandle consu
/**
* Returns the system time.
* Returns the number of milliseconds since the start of the system process.
* Based on ANSI clock() routine.
* Returns the number of milliseconds since the start of the system.
*
* \param systemhandle: The handle to the system.
* \return The number of milliseconds.
*/

@ -170,8 +170,10 @@ class GHOST_ISystem {
/**
* Returns the system time.
* Returns the number of milliseconds since the start of the system process.
* Based on ANSI clock() routine.
* Returns the number of milliseconds since the start of the system.
* \note The exact method used is platform dependent however monotonic methods should be used
* instead of wall-clock time.
*
* \return The number of milliseconds.
*/
virtual uint64_t getMilliSeconds() const = 0;