Explorar o código

Update documentation

Daniele Bartolini %!s(int64=12) %!d(string=hai) anos
pai
achega
757bbe84c5
Modificáronse 1 ficheiros con 3 adicións e 2 borrados
  1. 3 2
      engine/os/ScopedMutex.h

+ 3 - 2
engine/os/ScopedMutex.h

@@ -31,18 +31,19 @@ OTHER DEALINGS IN THE SOFTWARE.
 namespace crown
 {
 
+/// Automatically locks a mutex when created and unlocks when destroyed.
 class ScopedMutex
 {
 public:
 
-	//-------------------------------------------------------------------------
+	/// Locks the given @a m mutex.
 	ScopedMutex(Mutex& m)
 		: m_mutex(m)
 	{
 		m_mutex.lock();
 	}
 
-	//-------------------------------------------------------------------------
+	/// Unlocks the mutex passed to ScopedMutex::ScopedMutex()
 	~ScopedMutex()
 	{
 		m_mutex.unlock();