From b4351e1a6b83a9cfbfc331af3753602a02dbe062 Mon Sep 17 00:00:00 2001 From: Laurent Pinchart Date: Tue, 11 Dec 2018 20:22:36 +0200 Subject: 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 --- src/libcamera/log.cpp | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'src') 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 */ -- cgit v1.2.1