From cf93dc659096d10cedb9f4220d98cb5e6ac95b7b Mon Sep 17 00:00:00 2001 From: Thomas Eichinger Date: Tue, 27 May 2014 16:26:47 +0200 Subject: [PATCH] core:debug: documentation for `DEBUG_PRINT` was confusing and wrong --- core/include/debug.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/core/include/debug.h b/core/include/debug.h index f3c8397f1b..15fcfc7940 100644 --- a/core/include/debug.h +++ b/core/include/debug.h @@ -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) * * @{ */