Skip to content

Commit eb07229

Browse files
authored
Merge pull request #12617 from evedon/ed-doxygen-mail
Correct doxygen for Mail::get
2 parents 532654e + 4df8432 commit eb07229

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

rtos/Mail.h

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -200,11 +200,12 @@ class Mail : private mbed::NonCopyable<Mail<T, queue_sz> > {
200200
*
201201
* @param millisec Timeout value (default: osWaitForever).
202202
*
203-
* @return Event that contains mail information or error code.
204-
* @retval osEventMessage Message received.
205-
* @retval osOK No mail is available (and no timeout was specified).
206-
* @retval osEventTimeout No mail has arrived during the given timeout period.
207-
* @retval osErrorParameter A parameter is invalid or outside of a permitted range.
203+
* @return Event that contains mail information and status code. The status code
204+
* is stored in the status member:
205+
* @a osEventMail Mail successfully received.
206+
* @a osOK No mail is available (and no timeout was specified).
207+
* @a osEventTimeout No mail has arrived during the given timeout period.
208+
* @a osErrorParameter A parameter is invalid or outside of a permitted range.
208209
*
209210
* @note You may call this function from ISR context if the millisec parameter is set to 0.
210211
*/

0 commit comments

Comments
 (0)