From patchwork Tue Dec 11 19:10:10 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Laurent Pinchart X-Patchwork-Id: 34 Return-Path: Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 31BFB60B0C for ; Tue, 11 Dec 2018 20:09:45 +0100 (CET) Received: from avalon.bb.dnainternet.fi (dfj612ybrt5fhg77mgycy-3.rev.dnainternet.fi [IPv6:2001:14ba:21f5:5b00:2e86:4862:ef6a:2804]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 4A04656E for ; Tue, 11 Dec 2018 20:09:44 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1544555384; bh=WxB+3HWO3qhHDeuQEj3YiZH0f1AgYhB1vTn7n1fbFsU=; h=From:To:Subject:Date:In-Reply-To:References:From; b=Jg1/Xhs6MKBx5XkdgkKymUlb5NEjp5chqdfMbx3DFTgmIdPFrHcB3tHlvBzR6VlF3 Mw1oTt10X+rhHz3xTIFkcCKcCm3S+3CnaO+CqTzhUjdl/jvtwpRW+0+6H7HwcjhyZe gt82tGFo62asOTFpWQNWI64ktR2ar4SO/ewo5TUI= From: Laurent Pinchart To: libcamera-devel@lists.libcamera.org Date: Tue, 11 Dec 2018 21:10:10 +0200 Message-Id: <20181211191011.6315-6-laurent.pinchart@ideasonboard.com> X-Mailer: git-send-email 2.19.2 In-Reply-To: <20181211191011.6315-1-laurent.pinchart@ideasonboard.com> References: <20181211191011.6315-1-laurent.pinchart@ideasonboard.com> MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH 5/6] libcamera: log: Fix Doxygen documentation X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 11 Dec 2018 19:09:45 -0000 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(-) 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 */