reworked link anchors and link text

[wxWidgets.git] / docs / doxygen / overviews / thread.h

diff --git a/docs/doxygen/overviews/thread.h b/docs/doxygen/overviews/thread.h
index 0796e629322dc5ce50bdedab296921051406016c..9dae705ae11027bae56d332c65c5fa718d5d98dc 100644 (file)
--- a/docs/doxygen/overviews/thread.h
+++ b/docs/doxygen/overviews/thread.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        thread
+// Name:        thread.h

 // Purpose:     topic overview
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     topic overview
 // Author:      wxWidgets team
 // RCS-ID:      $Id$


@@ -10,18 +10,14 @@
 
  @page overview_thread Multithreading overview
 
 
  @page overview_thread Multithreading overview
 

- Classes: #wxThread, #wxMutex,
- #wxCriticalSection,
- #wxCondition
+ Classes: #wxThread, #wxMutex, #wxCriticalSection, #wxCondition

 
  wxWidgets provides a complete set of classes encapsulating objects necessary in
 
  wxWidgets provides a complete set of classes encapsulating objects necessary in

- multithreaded (MT) programs: the #thread class itself and different
- synchronization objects: #mutexes and
- @ref criticalsection_overview with
- #conditions. The thread API in wxWidgets resembles to
- POSIX1.c threads API (a.k.a. pthreads), although several functions have
- different names and some features inspired by Win32 thread API are there as
- well.
+ multithreaded (MT) programs: the wxThread class itself and different
+ synchronization objects: mutexes (see wxMutex) and critical sections (see 
+ wxCriticalSection)  with conditions (see wxCondition). The thread API in wxWidgets 
+ resembles to POSIX1.c threads API (a.k.a. pthreads), although several functions have
+ different names and some features inspired by Win32 thread API are there as well.

 
  These classes will hopefully make writing MT programs easier and they also
  provide some extra error checking (compared to the native (be it Win32 or Posix)
 
  These classes will hopefully make writing MT programs easier and they also
  provide some extra error checking (compared to the native (be it Win32 or Posix)


@@ -33,10 +29,9 @@
  new thread for each new client), but in others it might be a very poor choice
  (example: launching a separate thread when doing a long computation to show a
  progress dialog). Other implementation choices are available: for the progress
  new thread for each new client), but in others it might be a very poor choice
  (example: launching a separate thread when doing a long computation to show a
  progress dialog). Other implementation choices are available: for the progress

- dialog example it is far better to do the calculations in the
- @ref idleevent_overview or even simply do everything at once
- but call wxWindow::Update() periodically to update
- the screen.
+ dialog example it is far better to do the calculations in the idle handler
+ (see @ref wxIdleEvent) or even simply do everything at once but call wxWindow::Update() 
+ periodically to update the screen.

 
  If you do decide to use threads in your application, it is strongly recommended
  that no more than one thread calls GUI functions. The thread sample shows that
 
  If you do decide to use threads in your application, it is strongly recommended
  that no more than one thread calls GUI functions. The thread sample shows that


@@ -49,17 +44,14 @@
  itself and not by the other threads).
 
  For communication between secondary threads and the main thread, you may use
  itself and not by the other threads).
 
  For communication between secondary threads and the main thread, you may use

- wxEvtHandler::AddPendingEvent
- or its short version #wxPostEvent. These functions
+ wxEvtHandler::AddPendingEvent or its short version #wxPostEvent. These functions

  have a thread-safe implementation so that they can be used as they are for
  sending events from one thread to another. However there is no built in method
  to send messages to the worker threads and you will need to use the available
  synchronization classes to implement the solution which suits your needs
  yourself. In particular, please note that it is not enough to derive
  have a thread-safe implementation so that they can be used as they are for
  sending events from one thread to another. However there is no built in method
  to send messages to the worker threads and you will need to use the available
  synchronization classes to implement the solution which suits your needs
  yourself. In particular, please note that it is not enough to derive

- your class from #wxThread and
- #wxEvtHandler to send messages to it: in fact, this does
- not work at all.
-
- */
+ your class from #wxThread and #wxEvtHandler to send messages to it: 
+ in fact, this does not work at all.

 
 

+*/