[libcamera-devel] [PATCH 5/6] libcamera: log: Fix Doxygen documentation

[Laurent Pinchart]

Now that the documentation can be compiled, Doxygen throws a few
warnings due to incorrect enum field naming. Fix it.

The \file block needs to be named after the header file in order for
Doxygen to document any global function, variable, typedef or enum
defined in the header (as documented in the Doxygen manual under the
\file command). We thus need to use log.h as the file name. No \file
block is needed for the .cpp file, as we don't want to generate
documentation for internal private globals.

Signed-off-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>
---
 src/libcamera/log.cpp | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/src/libcamera/log.cpp b/src/libcamera/log.cpp
index 2a3824972c9a..c5345cf079a3 100644
--- a/src/libcamera/log.cpp
+++ b/src/libcamera/log.cpp
@@ -14,7 +14,7 @@
 #include "utils.h"
 
 /**
- * \file log.cpp
+ * \file log.h
  * \brief Logging infrastructure
  */
 
@@ -23,11 +23,11 @@ namespace libcamera {
 /**
  * \enum LogSeverity
  * Log message severity
- * \var Info
+ * \var LogInfo
  * Informational message
- * \var Warning
+ * \var LogWarning
  * Warning message, signals a potential issue
- * \var Error
+ * \var LogError
  * Error message, signals an unrecoverable issue
  */
 
-- 
Regards,

Laurent Pinchart