core:debug: documentation for DEBUG_PRINT was confusing and wrong

This commit is contained in:
Thomas Eichinger 2014-05-27 16:26:47 +02:00
parent cc83220f48
commit cf93dc6590

View File

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