[libcamera-devel] [PATCH] libcamera: log: Hide value of the ASSERT() macro

[Sebastian Fricke]

Hey Laurent,

Thank you for the patch.

On 22.05.2021 03:23, Laurent Pinchart wrote:
>ASSERT() is a function-like macro that expands to internal code. Hide
>the expansion from the generated documentation, as it would only confuse
>the reader.

Sounds good.

>
>Signed-off-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>
Reviewed-by: Sebastian Fricke <sebastian.fricke at posteo.net>

>---
> src/libcamera/log.cpp | 1 +
> 1 file changed, 1 insertion(+)
>
>diff --git a/src/libcamera/log.cpp b/src/libcamera/log.cpp
>index 985952249289..dd991647b9bc 100644
>--- a/src/libcamera/log.cpp
>+++ b/src/libcamera/log.cpp
>@@ -990,6 +990,7 @@ LogMessage _log(const LogCategory *category, LogSeverity severity,
>
> /**
>  * \def ASSERT(condition)
>+ * \hideinitializer
>  * \brief Abort program execution if assertion fails
>  *
>  * If \a condition is false, ASSERT() logs an error message with the Fatal log
>-- 
>Regards,
>
>Laurent Pinchart
>