mbed official
mbed library sources. Supersedes mbed-src.
Dependents: Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more
Diff: platform/mbed_assert.h
- Revision:
- 178:79309dc6340a
- Parent:
- 151:5eaa88a5bcc7
- Child:
- 188:bcfe06ba3d64
--- a/platform/mbed_assert.h Wed Nov 08 13:50:44 2017 +0000
+++ b/platform/mbed_assert.h Thu Nov 23 11:57:25 2017 +0000
@@ -1,6 +1,10 @@
/** \addtogroup platform */
/** @{*/
+/**
+ * \defgroup platform_Assert Assert macros
+ * @{
+ */
/* mbed Microcontroller Library
* Copyright (c) 2006-2013 ARM Limited
*
@@ -39,6 +43,19 @@
}
#endif
+/** MBED_ASSERT
+ * Declare runtime assertions: results in runtime error if condition is false
+ *
+ * @note
+ * Use of MBED_ASSERT is limited to Debug and Develop builds.
+ *
+ * @code
+ *
+ * int Configure(serial_t *obj) {
+ * MBED_ASSERT(obj);
+ * }
+ * @endcode
+ */
#ifdef NDEBUG
#define MBED_ASSERT(expr) ((void)0)
@@ -110,4 +127,7 @@
#endif
-/** @}*/
+/**@}*/
+
+/**@}*/
+
