little doc correction

2020-08-07 22:06:20 +02:00 · 2020-08-07 22:06:20 +02:00 · 44b70b45e2
commit 44b70b45e2
parent e3d094b2de
1 changed files with 2 additions and 2 deletions
--- a/ipc/MutexIF.h
+++ b/ipc/MutexIF.h
@ -21,10 +21,10 @@ public:
    };

    /**
-     * Lock the mutex.
+     * Lock the mutex. The timeout value will only be used for
+     * TimeoutType::WAITING
     * @param timeoutType
     * @param timeoutMs
-     * This value will only be used for TimeoutType::WAIT
     * @return
     */
    virtual ReturnValue_t lockMutex(TimeoutType timeoutType =