wxWidgets/interface/wx/time.h
Vadim Zeitlin ccba6d73f9 Fix use of Doxygen grouping
Fix wrong use of Doxygen grouping-related markup which somehow worked in
older Doxygen versions, but doesn't work any longer.

This fixes the problem with the "Functions by Category" pages being
empty in the resulting HTML documentation and wrong documentation being
shown for a bunch of wxString members.

This is a combined cherry-pick of the following master commits:

bd92523bc5 Fix use of Doxygen @addtogroup command
4c46e01b14 Remove stray Doxygen end group marker
8ac10d28f8 Fix all the other comments with Doxygen grouping commands too
c0f1ecf263 Fix another unbalanced Doxygen grouping command after last commit

See #22248, #22572.
2022-08-18 19:15:47 +02:00

73 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();
///@}