Diff: rtos/Mail.h

Revision:

1:9db0e321a9f4

Parent:

0:5b88d5760320

--- a/rtos/Mail.h	Tue Dec 17 23:23:45 2019 +0000
+++ b/rtos/Mail.h	Tue Dec 31 06:02:27 2019 +0000
@@ -1,5 +1,5 @@
 /* mbed Microcontroller Library
- * Copyright (c) 2006-2017 ARM Limited
+ * Copyright (c) 2006-2019 ARM Limited
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -25,11 +25,11 @@
 #include <stdint.h>
 #include <string.h>
 
-#include "Queue.h"
-#include "MemoryPool.h"
-#include "cmsis_os2.h"
-#include "mbed_rtos_storage.h"
-#include "mbed_rtos1_types.h"
+#include "rtos/Queue.h"
+#include "rtos/MemoryPool.h"
+#include "rtos/mbed_rtos_types.h"
+#include "rtos/mbed_rtos_storage.h"
+#include "rtos/mbed_rtos1_types.h"
 
 #include "platform/mbed_toolchain.h"
 #include "platform/NonCopyable.h"
@@ -38,9 +38,12 @@
 using namespace rtos;
 #endif
 
+#if MBED_CONF_RTOS_PRESENT || defined(DOXYGEN_ONLY)
+
 namespace rtos {
-/** \addtogroup rtos */
+/** \addtogroup rtos-public-api */
 /** @{*/
+
 /**
  * \defgroup rtos_Mail Mail class
  * @{
@@ -95,7 +98,7 @@
      *
      * @param   millisec  Not used (see note).
      *
-     * @return  Pointer to memory block that you can fill with mail or NULL in case error.
+     * @return  Pointer to memory block that you can fill with mail or nullptr in case error.
      *
      * @note You may call this function from ISR context.
      * @note If blocking is required, use Mail::alloc_for or Mail::alloc_until
@@ -109,7 +112,7 @@
      *
      * @param   millisec  Timeout value, or osWaitForever.
      *
-     * @return  Pointer to memory block that you can fill with mail or NULL in case error.
+     * @return  Pointer to memory block that you can fill with mail or nullptr in case error.
      *
      * @note You may call this function from ISR context if the millisec parameter is set to 0.
      */
@@ -122,7 +125,7 @@
      *
      * @param   millisec  Absolute timeout time, referenced to Kernel::get_ms_count().
      *
-     * @return  Pointer to memory block that you can fill with mail or NULL in case error.
+     * @return  Pointer to memory block that you can fill with mail or nullptr in case error.
      *
      * @note You cannot call this function from ISR context.
      * @note the underlying RTOS may have a limit to the maximum wait time
@@ -139,7 +142,7 @@
      *
      * @param   millisec  Not used (see note).
      *
-     * @return  Pointer to memory block that you can fill with mail or NULL in case error.
+     * @return  Pointer to memory block that you can fill with mail or nullptr in case error.
      *
      * @note You may call this function from ISR context if the millisec parameter is set to 0.
      * @note If blocking is required, use Mail::calloc_for or Mail::calloc_until
@@ -153,7 +156,7 @@
      *
      * @param   millisec  Timeout value, or osWaitForever.
      *
-     * @return  Pointer to memory block that you can fill with mail or NULL in case error.
+     * @return  Pointer to memory block that you can fill with mail or nullptr in case error.
      *
      * @note You may call this function from ISR context if the millisec parameter is set to 0.
      */
@@ -166,7 +169,7 @@
      *
      * @param   millisec  Absolute timeout time, referenced to Kernel::get_ms_count().
      *
-     * @return  Pointer to memory block that you can fill with mail or NULL in case error.
+     * @return  Pointer to memory block that you can fill with mail or nullptr in case error.
      *
      * @note You cannot call this function from ISR context.
      * @note the underlying RTOS may have a limit to the maximum wait time
@@ -238,5 +241,5 @@
 
 #endif
 
+#endif
 
-