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

Merge pull request #12617 from evedon/ed-doxygen-mail 

Correct doxygen for Mail::get
pull/12631/head
Martin Kojtal 2020-03-16 14:07:30 +00:00 committed by GitHub
parent 532654ebb3 4df8432523
commit eb07229177
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
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). * @param millisec Timeout value (default: osWaitForever).
* *
* @return Event that contains mail information or error code. * @return Event that contains mail information and status code. The status code
* @retval osEventMessage Message received. * is stored in the status member:
* @retval osOK No mail is available (and no timeout was specified). * @a osEventMail Mail successfully received.
* @retval osEventTimeout No mail has arrived during the given timeout period. * @a osOK No mail is available (and no timeout was specified).
* @retval osErrorParameter A parameter is invalid or outside of a permitted range. * @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. * @note You may call this function from ISR context if the millisec parameter is set to 0.
*/ */