Merge "Clean up the code to build successfully on macOS" into devel/master

[platform/core/uifw/dali-core.git] / dali / integration-api / debug.h

diff --git a/dali/integration-api/debug.h b/dali/integration-api/debug.h
index 5b2f40c..fe6c0d7 100644 (file)
--- a/dali/integration-api/debug.h
+++ b/dali/integration-api/debug.h
@@ -467,9 +467,15 @@ public:                                    \
 /********************************************************************************
  *                            Time instrumentation                              *
  ********************************************************************************/
-
 #if defined(DEBUG_ENABLED)
 
+ /**
+  * @brief Get the monotonic time since the clock's epoch.
+  *
+  * @param[out]  timeInNanoseconds  The time in nanoseconds since the reference point.
+  *
+  * @note The maximum value timeInNanoseconds can hold is 0xFFFFFFFFFFFFFFFF which is 1.844674407e+19. Therefore, this can overflow after approximately 584 years.
+  */
 void GetNanoseconds(uint64_t& timeInNanoseconds);
 
 #define DALI_LOG_TIMER_START(timeVariable) \