ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updated doxygen for Mail get API

pull/12617/head
Evelyne Donnaes 2020-03-11 16:25:11 +00:00
parent d5f034b637
commit 4df8432523
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
rtos/Mail.h
View File

@ -200,11 +200,12 @@ public:
*
* @param millisec Timeout value (default: osWaitForever).
*
* @return Event that contains mail information or error code.
* @retval osEventMessage Message received.
* @retval osOK No mail is available (and no timeout was specified).
* @retval osEventTimeout No mail has arrived during the given timeout period.
* @retval osErrorParameter A parameter is invalid or outside of a permitted range.
* @return Event that contains mail information and status code. The status code
* is stored in the status member:
* @a osEventMail Mail successfully received.
* @a osOK No mail is available (and no timeout was specified).
* @a osEventTimeout No mail has arrived during the given timeout period.
* @a osErrorParameter A parameter is invalid or outside of a permitted range.
*
* @note You may call this function from ISR context if the millisec parameter is set to 0.
*/