Changeset 2598 in Sophya for trunk/SophyaLib/SysTools/zthread.h

Timestamp:

Aug 11, 2004, 3:10:25 PM (21 years ago)

Author:

ansari

Message:

Documentation (ajoutee ou completee) pour les classes du module SysTools - Reza 11 Aout 2004

File:

• trunk/SophyaLib/SysTools/zthread.h (modified) (2 diffs)

trunk/SophyaLib/SysTools/zthread.h

@@ -16 +16 @@
 
 /*!
-  \class SOPHYA::ZThreadExc
+  \class ZThreadExc
   \ingroup SysTools
-  This exception class is used by the classes implementing the interface 
-  to the POSIX threads (\b ZThread ...)
+  \brief Exception class used by ZThread and ZMutex classes.
 */  
 class ZThreadExc : public PException {
@@ -93 +92 @@
 class ZSync {
 public:
+/*!
+  Constructor. Locks the associated ZMutex. 
+  
+  - <tt> sigbr==1 </tt> destructor calls \c signal on 
+  the associated ZMutex 
+  - <tt> sigbr==2 </tt> destructor calls \c broadcast on 
+  the associated ZMutex 
+*/
   explicit inline  ZSync(ZMutex & mtx, int sigbr=0) 
   {_mtx = &mtx; _sigbr = sigbr; mtx.lock(); }