Skip to content

Commit 5abe427

Browse files
Amanda ButlerCruz Monrreal II
authored andcommitted
Edit Mail.h
Edit file for active voice, branding and comma use.
1 parent f57d897 commit 5abe427

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

rtos/Mail.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,14 @@ namespace rtos {
4343
* @{
4444
*/
4545

46-
/** The Mail class allows you to control, send, receive, or wait for mail.
47-
* A mail is a memory block that is sent to a thread or interrupt service routine.
46+
/** The Mail class allows you to control, send, receive or wait for mail.
47+
* A mail is a memory block that is sent to a thread or interrupt service routine (ISR).
4848
* @tparam T Data type of a single mail message element.
4949
* @tparam queue_sz Maximum number of mail messages in queue.
5050
*
5151
* @note
5252
* Memory considerations: The mail data store and control structures are part of this class - they do not (themselves)
53-
* allocate memory on the heap, both for the mbed OS and underlying RTOS objects (static or dynamic RTOS memory
53+
* allocate memory on the heap, both for the Mbed OS and underlying RTOS objects (static or dynamic RTOS memory
5454
* pools are not being used).
5555
*/
5656
template<typename T, uint32_t queue_sz>
@@ -92,19 +92,19 @@ class Mail : private mbed::NonCopyable<Mail<T, queue_sz> > {
9292
*
9393
* @param millisec Not used.
9494
*
95-
* @return Pointer to memory block that can be filled with mail or NULL in case error.
95+
* @return Pointer to memory block that you can fill with mail or NULL in case error.
9696
*
9797
* @note You may call this function from ISR context.
9898
*/
9999
T* alloc(uint32_t millisec=0) {
100100
return _pool.alloc();
101101
}
102102

103-
/** Allocate a memory block of type T and set memory block to zero.
103+
/** Allocate a memory block of type T, and set memory block to zero.
104104
*
105105
* @param millisec Not used.
106106
*
107-
* @return Pointer to memory block that can be filled with mail or NULL in case error.
107+
* @return Pointer to memory block that you can fill with mail or NULL in case error.
108108
*
109109
* @note You may call this function from ISR context.
110110
*/

0 commit comments

Comments
 (0)