Document that wxDateTime::UNow() returns UTC time.

This wasn't clear and was probably surprising as this is different from Now()
behaviour.

See #14149.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@71033 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/interface/wx/datetime.h b/interface/wx/datetime.h
index b517d4d882081ed110fb6031b0da5fd7a737d56b..96d7896d85b6fb2fd3e0466fe0e80c2cabc60888 100644 (file)
--- a/interface/wx/datetime.h
+++ b/interface/wx/datetime.h
@@ -1604,9 +1604,8 @@ public:
         printf("Current time in Paris:\t%s\n", now.Format("%c", wxDateTime::CET).c_str());
         @endcode
 
         printf("Current time in Paris:\t%s\n", now.Format("%c", wxDateTime::CET).c_str());
         @endcode
 

-        @note This function is accurate up to seconds. UNow() should be used
-              for better precision, but it is less efficient and might not be
-              available on all platforms.
+        @note This function is accurate up to seconds. UNow() can be used if
+              better precision is required.

 
         @see Today()
     */
 
         @see Today()
     */


@@ -1641,11 +1640,13 @@ public:
     static wxDateTime Today();
 
     /**
     static wxDateTime Today();
 
     /**

-        Returns the object corresponding to the current time including the
-        milliseconds if a function to get time with such precision is available
-        on the current platform (supported under most Unices and Win32).
+        Returns the object corresponding to the current UTC time including the
+        milliseconds.

 
 

-        @see Now()
+        Notice that unlike Now(), this method creates a wxDateTime object
+        corresponding to UTC, not local, time.
+
+        @see Now(), wxGetUTCTimeMillis()

     */
     static wxDateTime UNow();
 };
     */
     static wxDateTime UNow();
 };