docs/doxygen/groups/funcmacro_thread.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        funcmacro_thread.h
   3 // Purpose:     Threads function and macro group docs
   4 // Author:      wxWidgets team
   5 // Licence:     wxWindows licence
   6 /////////////////////////////////////////////////////////////////////////////
   7
   8 /**
   9
  10 @defgroup group_funcmacro_thread Threads
  11 @ingroup group_funcmacro
  12
  13 The functions and macros here mainly exist to make it possible to write code
  14 which may be compiled in multi thread build (wxUSE_THREADS = 1) as well as in
  15 single thread configuration (wxUSE_THREADS = 0).
  16
  17 For example, a static variable must be protected against simultaneous access by
  18 multiple threads in the former configuration but in the latter the extra
  19 overhead of using the critical section is not needed. To solve this problem,
  20 the wxCRITICAL_SECTION() macro may be used to create and use the critical
  21 section only when needed.
  22
  23 @sa wxThread, wxMutex, @ref overview_thread
  24
  25 Related class group: @ref group_class_threading
  26
  27 */
  28