bd92523bc5
Put Doxygen grouping constructs ("@{" and "@}") in Doxygen comments
rather than plain C++ ones to make them actually take effect. Some old
Doxygen versions (~1.8.5) did recognize them even in plain comments, but
the currently uses 1.9.1 one does not and @addtogroup didn't have any
effect as the result.
This fixes the problem with the "Functions by Category" pages being
empty in the resulting HTML documentation.
See #22572.
72 lines
1.7 KiB
C
72 lines
1.7 KiB
C
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: wx/time.h
|
|
// Purpose: Time-related functions.
|
|
// Author: Vadim Zeitlin
|
|
// Created: 2011-11-27
|
|
// Copyright: (c) 2011 Vadim Zeitlin <vadim@wxwidgets.org>
|
|
// Licence: wxWindows licence
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
/** @addtogroup group_funcmacro_time */
|
|
///@{
|
|
|
|
/**
|
|
Returns the difference between UTC and local time in seconds.
|
|
|
|
This function intentionally doesn't take DST into account, i.e. the offset
|
|
returned is the same one independently of when the function is called.
|
|
|
|
@header{wx/time.h}
|
|
*/
|
|
int wxGetTimeZone();
|
|
|
|
/**
|
|
Returns the number of seconds since local time 00:00:00 Jan 1st 1970.
|
|
|
|
@see wxDateTime::Now()
|
|
|
|
@header{wx/time.h}
|
|
*/
|
|
long wxGetLocalTime();
|
|
|
|
/**
|
|
Returns the number of milliseconds since local time 00:00:00 Jan 1st 1970.
|
|
|
|
The use of wxGetUTCTimeMillis() is preferred as it provides a usually
|
|
(except for changes to the system time) monotonic clock which the local
|
|
time also changes whenever DST begins or ends.
|
|
|
|
@see wxDateTime::Now(), wxGetUTCTimeMillis(), wxGetUTCTimeUSec()
|
|
|
|
@header{wx/time.h}
|
|
*/
|
|
wxLongLong wxGetLocalTimeMillis();
|
|
|
|
/**
|
|
Returns the number of seconds since GMT 00:00:00 Jan 1st 1970.
|
|
|
|
@see wxDateTime::Now()
|
|
|
|
@header{wx/time.h}
|
|
*/
|
|
long wxGetUTCTime();
|
|
|
|
/**
|
|
Returns the number of milliseconds since GMT 00:00:00 Jan 1st 1970.
|
|
|
|
@header{wx/time.h}
|
|
|
|
@since 2.9.3
|
|
*/
|
|
wxLongLong wxGetUTCTimeMillis();
|
|
|
|
/**
|
|
Returns the number of microseconds since GMT 00:00:00 Jan 1st 1970.
|
|
|
|
@header{wx/time.h}
|
|
|
|
@since 2.9.3
|
|
*/
|
|
wxLongLong wxGetUTCTimeUSec();
|
|
|
|
///@}
|