From patchwork Tue Oct 20 00:03:07 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Laurent Pinchart X-Patchwork-Id: 10102 Return-Path: X-Original-To: parsemail@patchwork.libcamera.org Delivered-To: parsemail@patchwork.libcamera.org Received: from lancelot.ideasonboard.com (lancelot.ideasonboard.com [92.243.16.209]) by patchwork.libcamera.org (Postfix) with ESMTPS id 3D510BDB20 for ; Tue, 20 Oct 2020 00:04:09 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 17E5D613B9; Tue, 20 Oct 2020 02:04:08 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=fail reason="signature verification failed" (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="CbWIzqq5"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id E67A060CE6 for ; Tue, 20 Oct 2020 02:04:05 +0200 (CEST) Received: from pendragon.lan (62-78-145-57.bb.dnainternet.fi [62.78.145.57]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 8B4E552 for ; Tue, 20 Oct 2020 02:04:05 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1603152245; bh=jbKwQifX6VEF/mQftap82PE6c+gUo2g4JVfeSx8vhWk=; h=From:To:Subject:Date:In-Reply-To:References:From; b=CbWIzqq5KJZ1N8++9ZxvEyzBnLm2q6AiLcFzXciIrLKSL8ynCAjPszMOQbobBABiM Ym8Znk/e4/0b0FhY1EMvpj2wSby6dPP8fcVPAooBBc/z7fc+UcVVIGGNBLJUM0k8ao js+HVErLXQQunVgFeuDBve+zzyFqxFbDfisBd/v8= From: Laurent Pinchart To: libcamera-devel@lists.libcamera.org Date: Tue, 20 Oct 2020 03:03:07 +0300 Message-Id: <20201020000310.3008-3-laurent.pinchart@ideasonboard.com> X-Mailer: git-send-email 2.27.0 In-Reply-To: <20201020000310.3008-1-laurent.pinchart@ideasonboard.com> References: <20201020000310.3008-1-laurent.pinchart@ideasonboard.com> MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH 2/5] ipa: Skip doxygen parsing for pipeline-specific IPA headers X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" The pipeline-specific IPA headers are not part of the libcamera API, they should thus be skipped when generating documentation. doxygen doesn't complain currently due to the fact that types defined in those headers are part of undocumented namespaces. In preparation for documenting the libcamera namespace, make sure the headers don't get parsed by doxygen. Only vimc.h needs a header guard, as rkisp1.h uses the global namespace and raspberrypi.h uses the undocumented libcamera::RPi namespace, neither of which cause issues. Still, for consistency, add header guards to all headers. Signed-off-by: Laurent Pinchart Reviewed-by: Paul Elder Acked-by: Kieran Bingham --- include/libcamera/ipa/raspberrypi.h | 4 ++++ include/libcamera/ipa/rkisp1.h | 4 ++++ include/libcamera/ipa/vimc.h | 4 ++++ 3 files changed, 12 insertions(+) diff --git a/include/libcamera/ipa/raspberrypi.h b/include/libcamera/ipa/raspberrypi.h index b3041591ff7c..b23baf2f1330 100644 --- a/include/libcamera/ipa/raspberrypi.h +++ b/include/libcamera/ipa/raspberrypi.h @@ -10,6 +10,8 @@ #include #include +#ifndef __DOXYGEN__ + namespace libcamera { namespace RPi { @@ -66,4 +68,6 @@ static const ControlInfoMap Controls = { } /* namespace libcamera */ +#endif /* __DOXYGEN__ */ + #endif /* __LIBCAMERA_IPA_INTERFACE_RASPBERRYPI_H__ */ diff --git a/include/libcamera/ipa/rkisp1.h b/include/libcamera/ipa/rkisp1.h index 4fe0482b8de5..bb824f292032 100644 --- a/include/libcamera/ipa/rkisp1.h +++ b/include/libcamera/ipa/rkisp1.h @@ -7,6 +7,8 @@ #ifndef __LIBCAMERA_IPA_INTERFACE_RKISP1_H__ #define __LIBCAMERA_IPA_INTERFACE_RKISP1_H__ +#ifndef __DOXYGEN__ + enum RkISP1Operations { RKISP1_IPA_ACTION_V4L2_SET = 1, RKISP1_IPA_ACTION_PARAM_FILLED = 2, @@ -15,4 +17,6 @@ enum RkISP1Operations { RKISP1_IPA_EVENT_QUEUE_REQUEST = 5, }; +#endif /* __DOXYGEN__ */ + #endif /* __LIBCAMERA_IPA_INTERFACE_RKISP1_H__ */ diff --git a/include/libcamera/ipa/vimc.h b/include/libcamera/ipa/vimc.h index 22d97992f80f..27a4a61df889 100644 --- a/include/libcamera/ipa/vimc.h +++ b/include/libcamera/ipa/vimc.h @@ -8,6 +8,8 @@ #ifndef __LIBCAMERA_IPA_VIMC_H__ #define __LIBCAMERA_IPA_VIMC_H__ +#ifndef __DOXYGEN__ + namespace libcamera { #define VIMC_IPA_FIFO_PATH "/tmp/libcamera_ipa_vimc_fifo" @@ -21,4 +23,6 @@ enum IPAOperationCode { } /* namespace libcamera */ +#endif /* __DOXYGEN__ */ + #endif /* __LIBCAMERA_IPA_VIMC_H__ */