@@ -43,14 +43,14 @@ namespace rtos {
43
43
* @{
44
44
*/
45
45
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) .
48
48
* @tparam T Data type of a single mail message element.
49
49
* @tparam queue_sz Maximum number of mail messages in queue.
50
50
*
51
51
* @note
52
52
* 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
54
54
* pools are not being used).
55
55
*/
56
56
template <typename T, uint32_t queue_sz>
@@ -92,19 +92,19 @@ class Mail : private mbed::NonCopyable<Mail<T, queue_sz> > {
92
92
*
93
93
* @param millisec Not used.
94
94
*
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.
96
96
*
97
97
* @note You may call this function from ISR context.
98
98
*/
99
99
T* alloc (uint32_t millisec=0 ) {
100
100
return _pool.alloc ();
101
101
}
102
102
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.
104
104
*
105
105
* @param millisec Not used.
106
106
*
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.
108
108
*
109
109
* @note You may call this function from ISR context.
110
110
*/
0 commit comments