summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLaurent Pinchart <laurent.pinchart@ideasonboard.com>2018-12-11 20:22:36 +0200
committerLaurent Pinchart <laurent.pinchart@ideasonboard.com>2018-12-12 20:45:39 +0200
commitb4351e1a6b83a9cfbfc331af3753602a02dbe062 (patch)
treeb10c13c55eac5efe90cdd8c9adbe7a7db31b3788
parent53c4d4c34fc49b95ca07265fc65940df9c365074 (diff)
libcamera: log: Fix Doxygen documentation
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@ideasonboard.com>
-rw-r--r--src/libcamera/log.cpp8
1 files changed, 4 insertions, 4 deletions
diff --git a/src/libcamera/log.cpp b/src/libcamera/log.cpp
index 2a382497..c5345cf0 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
*/