From patchwork Wed Apr 7 14:10:41 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jacopo Mondi X-Patchwork-Id: 11858 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 BCD5EBD1F6 for ; Wed, 7 Apr 2021 14:10:31 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 1F595687A2; Wed, 7 Apr 2021 16:10:31 +0200 (CEST) Received: from relay9-d.mail.gandi.net (relay9-d.mail.gandi.net [217.70.183.199]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 3AEA7687A1 for ; Wed, 7 Apr 2021 16:10:29 +0200 (CEST) X-Originating-IP: 93.34.118.233 Received: from uno.lan (93-34-118-233.ip49.fastwebnet.it [93.34.118.233]) (Authenticated sender: jacopo@jmondi.org) by relay9-d.mail.gandi.net (Postfix) with ESMTPSA id BC700FF80D; Wed, 7 Apr 2021 14:10:28 +0000 (UTC) From: Jacopo Mondi To: libcamera-devel@lists.libcamera.org Date: Wed, 7 Apr 2021 16:10:41 +0200 Message-Id: <20210407141041.31087-1-jacopo@jmondi.org> X-Mailer: git-send-email 2.31.1 MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH] libcamera: camera_data: Document requestSequence_ 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 CameraData::requestSequence_ field was not documented. Fix it. Also remove an empty line the class declaration as the field is not special compared to the other existing ones. Fixes the doxygen warning /include/libcamera/internal/pipeline_handler.h:51: warning: Member requestSequence_ (variable) of class libcamera::CameraData is not documented. Signed-off-by: Jacopo Mondi --- Isn't it a bit fishy that the counter is never reset ? --- include/libcamera/internal/pipeline_handler.h | 1 - src/libcamera/pipeline_handler.cpp | 8 ++++++++ 2 files changed, 8 insertions(+), 1 deletion(-) -- 2.31.1 diff --git a/include/libcamera/internal/pipeline_handler.h b/include/libcamera/internal/pipeline_handler.h index c6454db6b2c4..82fdc1fee9b9 100644 --- a/include/libcamera/internal/pipeline_handler.h +++ b/include/libcamera/internal/pipeline_handler.h @@ -47,7 +47,6 @@ public: std::list queuedRequests_; ControlInfoMap controlInfo_; ControlList properties_; - uint32_t requestSequence_; private: diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp index 433c05f60db0..7f4fa1b4ba89 100644 --- a/src/libcamera/pipeline_handler.cpp +++ b/src/libcamera/pipeline_handler.cpp @@ -97,6 +97,14 @@ LOG_DEFINE_CATEGORY(Pipeline) * when creating the camera, and shall not be modified afterwards. */ +/** + * \var CameraData::requestSequence_ + * \brief The request sequence counter + * + * The request sequence counter is increased when a new Request is queued to + * the camera and monotonically increases during the whole library lifetime. + */ + /** * \class PipelineHandler * \brief Create and manage cameras based on a set of media devices