--- parser3/src/include/pa_threads.h	2001/03/10 16:34:35	1.5
+++ parser3/src/include/pa_threads.h	2001/03/19 17:42:13	1.9
@@ -1,9 +1,11 @@
-/*
-	Parser
+/** @file
+	Parser: mutex & helpers decls.
+
 	Copyright (c) 2001 ArtLebedev Group (http://www.artlebedev.com)
-	Author: Alexander Petrosyan <paf@design.ru>
 
-	$Id: pa_threads.h,v 1.5 2001/03/10 16:34:35 paf Exp $
+	Author: Alexander Petrosyan <paf@design.ru> (http://design.ru/paf)
+
+	$Id: pa_threads.h,v 1.9 2001/03/19 17:42:13 paf Exp $
 */
 
 #ifndef PA_THREADS_H
@@ -18,6 +20,7 @@
 
 #ifdef MULTITHREAD
 
+/// simple semaphore object
 class Mutex {
 	uint handle;
 public:
@@ -29,6 +32,11 @@ public:
 
 extern Mutex global_mutex;
 
+/** 
+	Helper to ensure paired Mutex::acquire() and Mutex::release().
+
+	Use it with SYNCHRONIZED macro
+*/
 class AutoSYNCHRONIZED {
 	bool thread_safe;
 public:
@@ -40,11 +48,22 @@ public:
 		if(thread_safe)
 			global_mutex.release(); 
 	}
-}
+};
+
+/** 
+	put it to first line of a function to ensure thread safety.
+
+	@verbatim
+	void someclass::somefunc(...) { SYNCHRONIZED(thread_safe);
+		...
+	}
+	@endverbatim
 
+	considering \a thread_safe to be the object field to flag 
+	whether safety is really needed in this particular object instance
+*/
 #define SYNCHRONIZED(athread_safe) AutoSYNCHRONIZED autoSYNCHRONIZED(athread_safe)
 
-
 #else // not MULTITHREAD-ed
 
 #define SYNCHRONIZED(athread_safe) /* do nothing */