Browse Source

[2198] Remove unnecessary text from API documentation

... as the methods are private anyway.
Mukund Sivaraman 12 years ago
parent
commit
40de1c10db
1 changed files with 0 additions and 9 deletions
  1. 0 9
      src/lib/util/threads/sync.h

+ 0 - 9
src/lib/util/threads/sync.h

@@ -131,9 +131,6 @@ private:
     /// \brief Lock the mutex
     ///
     /// This method blocks until the mutex can be locked.
-    ///
-    /// Please consider not using this method directly and instead using
-    /// a Mutex::Locker object instead.
     void lock();
 
     /// \brief Try to lock the mutex
@@ -141,16 +138,10 @@ private:
     /// This method doesn't block and returns immediately with a status
     /// on whether the lock operation was successful.
     ///
-    /// Please consider not using this method directly and instead using
-    /// a Mutex::Locker object instead.
-    ///
     /// \return true if the lock was successful, false otherwise.
     bool tryLock();
 
     /// \brief Unlock the mutex
-    ///
-    /// Please consider not using this method directly and instead using
-    /// a Mutex::Locker object instead.
     void unlock();
 
 private: