]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/critsect.tex
As per the wx-dev discussion in early Jan, replaced
[wxWidgets.git] / docs / latex / wx / critsect.tex
index 884c3ed19cfc81f40cd4004f2fc6c235da48e0b1..d2c67ee3dfbcc8153ef50ee65c9ab2d6fdd74808 100644 (file)
@@ -1,7 +1,7 @@
 \section{\class{wxCriticalSection}}\label{wxcriticalsection}
 
-A critical section object is used exactly for the same purpose as 
-\helpref{mutexes}{wxMutex}. The only difference is that under Windows platform
+A critical section object is used for the same exactly purpose as 
+\helpref{mutexes}{wxmutex}. The only difference is that under Windows platform
 critical sections are only visible inside one process, while mutexes may be
 shared between processes, so using critical sections is slightly more
 efficient. The terminology is also slightly different: mutex may be locked (or
@@ -18,24 +18,31 @@ possible instead of directly using wxCriticalSection for the same reasons
 
 None.
 
+\wxheading{Include files}
+
+<wx/thread.h>
+
 \wxheading{See also}
 
-\helpref{wxThread}{wxthread}, \helpref{wxCondition}{wxcondition},
+\helpref{wxThread}{wxthread}, \helpref{wxCondition}{wxcondition}, 
 \helpref{wxMutexLocker}{wxmutexlocker}, \helpref{wxCriticalSection}{wxcriticalsection}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxCriticalSection::wxCriticalSection}\label{wxcriticalsectionctor}
+
 \func{}{wxCriticalSection}{\void}
 
 Default constructor initializes critical section object.
 
 \membersection{wxCriticalSection::\destruct{wxCriticalSection}}\label{wxcriticalsectiondtor}
+
 \func{}{\destruct{wxCriticalSection}}{\void}
 
 Destructor frees the ressources.
 
 \membersection{wxCriticalSection::Enter}\label{wxcriticalsectionenter}
+
 \func{void }{Enter}{\void}
 
 Enter the critical section (same as locking a mutex). There is no error return
@@ -43,7 +50,9 @@ for this function. After entering the critical section protecting some global
 data the thread running in critical section may safely use/modify it.
 
 \membersection{wxCriticalSection::Leave}\label{wxcriticalsectionleave}
+
 \func{void }{Leave}{\void}
 
 Leave the critical section allowing other threads use the global data protected
 by it. There is no error return for this function.
+