aboutsummaryrefslogtreecommitdiffstats
path: root/os/kernel/include/chmboxes.h
diff options
context:
space:
mode:
Diffstat (limited to 'os/kernel/include/chmboxes.h')
-rw-r--r--os/kernel/include/chmboxes.h13
1 files changed, 8 insertions, 5 deletions
diff --git a/os/kernel/include/chmboxes.h b/os/kernel/include/chmboxes.h
index a5088b2c5..4447b02d1 100644
--- a/os/kernel/include/chmboxes.h
+++ b/os/kernel/include/chmboxes.h
@@ -28,7 +28,7 @@
#ifndef _CHMBOXES_H_
#define _CHMBOXES_H_
-#if CH_USE_MAILBOXES
+#if CH_USE_MAILBOXES || defined(__DOXYGEN__)
/*
* Module dependencies check.
@@ -37,6 +37,9 @@
#error "CH_USE_MAILBOXES requires CH_USE_SEMAPHORES"
#endif
+/**
+ * @brief Structure representing a mailbox object.
+ */
typedef struct {
msg_t *mb_buffer; /**< @brief Pointer to the mailbox
buffer. */
@@ -99,10 +102,10 @@ extern "C" {
/**
* @brief Returns the next message in the queue without removing it.
- * @note A message must be waiting in the queue for this function to work or
- * it would return garbage. The correct way to use this macro is to
- * use @p chMBGetFull() and then use this macro, all within a lock
- * state.
+ * @pre A message must be waiting in the queue for this function to work
+ * or it would return garbage. The correct way to use this macro is
+ * to use @p chMBGetFull() and then use this macro, all within a
+ * lock state.
*/
#define chMBPeek(mbp) (*(mbp)->mb_rdptr)