Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Fork of mbed-dev by
Diff: platform/mbed_error.h
- Revision:
- 167:e84263d55307
- Parent:
- 149:156823d33999
diff -r c97ed07ec1a8 -r e84263d55307 platform/mbed_error.h --- a/platform/mbed_error.h Thu Jun 08 15:02:37 2017 +0100 +++ b/platform/mbed_error.h Wed Jun 21 17:46:44 2017 +0100 @@ -19,8 +19,13 @@ #ifndef MBED_ERROR_H #define MBED_ERROR_H + + /** To generate a fatal compile-time error, you can use the pre-processor #error directive. * + * @param format C string that contains data stream to be printed. + * Code snippets below show valid format. + * * @code * #error "That shouldn't have happened!" * @endcode @@ -53,13 +58,14 @@ * if(x >= 5) { * error("expected x to be less than 5, but got %d", x); * } - * #endcode + * @endcode + * + * */ #ifdef __cplusplus extern "C" { #endif - void error(const char* format, ...); #ifdef __cplusplus