Correct ConditionVariable ISR comments

No ConditionVariable methods are useable from ISR, due to the built-in
mutex and the requirement that the caller of notify holds the mutex.
pull/5419/head
Kevin Bracey 2018-01-18 10:23:41 +02:00
parent 99dc805e79
commit 3bb2c445ca
1 changed files with 4 additions and 4 deletions

View File

@ -120,7 +120,7 @@ class ConditionVariable : private mbed::NonCopyable<ConditionVariable> {
public: public:
/** Create and Initialize a ConditionVariable object /** Create and Initialize a ConditionVariable object
* *
* @note You may call this function from ISR context. * @note You cannot call this function from ISR context.
*/ */
ConditionVariable(Mutex &mutex); ConditionVariable(Mutex &mutex);
@ -190,7 +190,7 @@ public:
* *
* @note - The thread calling this function must be the owner of the ConditionVariable's mutex * @note - The thread calling this function must be the owner of the ConditionVariable's mutex
* *
* @note This function may be called from ISR context. * @note You cannot call this function from ISR context.
*/ */
void notify_one(); void notify_one();
@ -198,13 +198,13 @@ public:
* *
* @note - The thread calling this function must be the owner of the ConditionVariable's mutex * @note - The thread calling this function must be the owner of the ConditionVariable's mutex
* *
* @note This function may be called from ISR context. * @note You cannot call this function from ISR context.
*/ */
void notify_all(); void notify_all();
/** ConditionVariable destructor /** ConditionVariable destructor
* *
* @note You may call this function from ISR context. * @note You cannot call this function from ISR context.
*/ */
~ConditionVariable(); ~ConditionVariable();