X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/23324ae1c7938ba904770fc456d3c07764b9c5e9..5d2d8f6ae38287516603c6e2e5ea81c7fee5efd6:/interface/atomic.h diff --git a/interface/atomic.h b/interface/atomic.h index 1e535a3a38..b2aba23510 100644 --- a/interface/atomic.h +++ b/interface/atomic.h @@ -1,15 +1,34 @@ ///////////////////////////////////////////////////////////////////////////// - // Name: atomic.h - // Purpose: documentation for global functions - // Author: wxWidgets team - // RCS-ID: $Id$ - // Licence: wxWindows license - ///////////////////////////////////////////////////////////////////////////// - - /** - This function increments @e value in an atomic manner. +// Name: atomic.h +// Purpose: interface of global functions +// Author: wxWidgets team +// RCS-ID: $Id$ +// Licence: wxWindows license +///////////////////////////////////////////////////////////////////////////// + + +// ============================================================================ +// Global functions/macros +// ============================================================================ + +/** @ingroup group_funcmacro_atomic */ +//@{ + +/** + This function increments @a value in an atomic manner. + + @header{wx/atomic.h} */ void wxAtomicInc(wxAtomicInt& value); +/** + This function decrements value in an atomic manner. Returns 0 if value is 0 + after decrementation or any non-zero value (not necessarily equal to the + value of the variable) otherwise. + + @header{wx/atomic.h} +*/ +wxInt32 wxAtomicDec(wxAtomicInt& value); + +//@} - \ No newline at end of file