remove daily build of docs

[wxWidgets.git] / interface / atomic.h

diff --git a/interface/atomic.h b/interface/atomic.h
index 1e535a3a3844d7941f610d8c8f9c4afaf5afb19d..3ec54209db8975ef86c7ef489adb88828476621a 100644 (file)
--- a/interface/atomic.h
+++ b/interface/atomic.h
@@ -1,15 +1,29 @@
 /////////////////////////////////////////////////////////////////////////////
-    // 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.
 */
 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.
+*/
+wxInt32 wxAtomicDec(wxAtomicInt& value);
 
-    
\ No newline at end of file
+//@}