]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/atomic.h
several g++ 4 warning fixes
[wxWidgets.git] / interface / atomic.h
index 1e535a3a3844d7941f610d8c8f9c4afaf5afb19d..b2aba23510eab1e29590319553f53559835b899b 100644 (file)
@@ -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