From a05032f2932d40901229916ac6bdcca7a1726e0a Mon Sep 17 00:00:00 2001 From: smlng Date: Mon, 20 Nov 2017 16:05:24 +0100 Subject: [PATCH] doc: describe usage of DEVELHELP --- doc.txt | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/doc.txt b/doc.txt index cea21b4a26..0755dbfe95 100644 --- a/doc.txt +++ b/doc.txt @@ -9,8 +9,11 @@ /** * @def DEVELHELP - * @brief This global macro activates some behavior that helps you while - * developing but is otherwise optimized out. + * @brief This global macro activates functionality to help developers. + * + * Additional code parts such as (extensive) debug output and sanity + * checks using assertions. To activate it set environment variable + * `DEVELHELP=1`, or disable explicitly with `DEVELHELP=0`. */ #if DOXYGEN # define DEVELHELP