1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00

Merge pull request #1248 from thomaseichinger/debug_h_doc_fix

core:debug: documentation for `DEBUG_PRINT` was confusing and wrong
This commit is contained in:
René Kijewski 2014-06-03 22:42:39 +02:00
commit aab2311205

View File

@ -28,10 +28,10 @@
/**
* @name Print debug information if the calling thread stack is large enough
*
* Use this macro the same as printf. When DEVHELP is defined inside an
* implementation file, all usages of *DEBUG_PRINTF* will print the given
* information to std-out. If DEVHELP is not set, all occurrences of
* *DEBUG_PRINTF* will be ignored.
* Use this macro the same as `printf`. When `DEVELHELP` is defined inside an
* implementation file, all usages of `DEBUG_PRINT` will print the given
* information to std-out after verifying the stack is big enough. If `DEVELHELP`
* is not set, this check is not performed. (CPU exception may occur)
*
* @{
*/