John Karatka / mbed

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 mbed official

Diff: platform/mbed_interface.h

Revision:
167:e84263d55307
Parent:
149:156823d33999
Child:
179:79309dc6340a
--- a/platform/mbed_interface.h	Thu Jun 08 15:02:37 2017 +0100
+++ b/platform/mbed_interface.h	Wed Jun 21 17:46:44 2017 +0100
@@ -113,16 +113,28 @@
 void mbed_die(void);
 
 /** Print out an error message.  This is typically called when
- * hanlding a crash.
+ * handling a crash.
+ *
+ * @note Synchronization level: Interrupt safe
  *
- * @Note Synchronization level: Interrupt safe
+ * @param format    C string that contains data stream to be printed.
+ *                  Code snippets below show valid format.
+ *
+ * @code
+ * mbed_error_printf("Failed: %s, file: %s, line %d \n", expr, file, line);
+ * @endcode
+ *
  */
 void mbed_error_printf(const char* format, ...);
 
 /** Print out an error message.  Similar to mbed_error_printf
  * but uses a va_list.
  *
- * @Note Synchronization level: Interrupt safe
+ * @note Synchronization level: Interrupt safe
+ *
+ * @param format    C string that contains data stream to be printed.
+ * @param arg       Variable arguments list
+ *
  */
 void mbed_error_vfprintf(const char * format, va_list arg);