ccba6d73f9
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.
49 lines
1.5 KiB
C++
49 lines
1.5 KiB
C++
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: atomic.h
|
|
// Purpose: interface of global functions
|
|
// Author: wxWidgets team
|
|
// Licence: wxWindows licence
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
|
// ============================================================================
|
|
// Global functions/macros
|
|
// ============================================================================
|
|
|
|
/** @addtogroup group_funcmacro_atomic */
|
|
///@{
|
|
|
|
/**
|
|
This function increments @a value in an atomic manner.
|
|
|
|
@note It is recommended to use @c std::atomic available in C++11 and later
|
|
instead of this function in any new code.
|
|
|
|
Whenever possible wxWidgets provides an efficient, CPU-specific,
|
|
implementation of this function. If such implementation is available, the
|
|
symbol wxHAS_ATOMIC_OPS is defined. Otherwise this function still exists
|
|
but is implemented in a generic way using a critical section which can be
|
|
prohibitively expensive for use in performance-sensitive code.
|
|
|
|
Returns the new value after the increment (the return value is only
|
|
available since wxWidgets 3.1.7, this function doesn't return anything in
|
|
previous versions of the library).
|
|
|
|
@header{wx/atomic.h}
|
|
*/
|
|
wxInt32 wxAtomicInc(wxAtomicInt& value);
|
|
|
|
/**
|
|
This function decrements value in an atomic manner.
|
|
|
|
Returns the new value after decrementing it.
|
|
|
|
@see wxAtomicInc
|
|
|
|
@header{wx/atomic.h}
|
|
*/
|
|
wxInt32 wxAtomicDec(wxAtomicInt& value);
|
|
|
|
///@}
|
|
|