From patchwork Fri Apr 19 13:25:24 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jacopo Mondi X-Patchwork-Id: 1087 Return-Path: Received: from relay7-d.mail.gandi.net (relay7-d.mail.gandi.net [217.70.183.200]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 937F260B2E for ; Fri, 19 Apr 2019 15:24:44 +0200 (CEST) X-Originating-IP: 2.224.242.101 Received: from uno.lan (2-224-242-101.ip172.fastwebnet.it [2.224.242.101]) (Authenticated sender: jacopo@jmondi.org) by relay7-d.mail.gandi.net (Postfix) with ESMTPSA id DE15220003; Fri, 19 Apr 2019 13:24:43 +0000 (UTC) From: Jacopo Mondi To: libcamera-devel@lists.libcamera.org Date: Fri, 19 Apr 2019 15:25:24 +0200 Message-Id: <20190419132531.17856-2-jacopo@jmondi.org> X-Mailer: git-send-email 2.21.0 In-Reply-To: <20190419132531.17856-1-jacopo@jmondi.org> References: <20190419132531.17856-1-jacopo@jmondi.org> MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH v8 1/8] libcamera: stream: Document protected members 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: Fri, 19 Apr 2019 13:24:44 -0000 Since commit: 4e1dc9004fca ("libcamera: stream: Make Stream inheritable") the private members of the Stream class have been turned into protected, to allows subclasses to access them. As Doxygen generates documentation for protected members (but not for private memebers), add documentation to the stream class for the 'bufferMap_' and 'configuration_' members. Fixes: 4e1dc9004fca ("libcamera: stream: Make Stream inheritable") Reviewed-by: Laurent Pinchart Signed-off-by: Jacopo Mondi --- src/libcamera/stream.cpp | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/src/libcamera/stream.cpp b/src/libcamera/stream.cpp index 71dd461db33b..aeb479c57b37 100644 --- a/src/libcamera/stream.cpp +++ b/src/libcamera/stream.cpp @@ -211,4 +211,22 @@ Stream::Stream() * \return The active configuration of the stream */ +/** + * \var Stream::bufferPool_ + * \brief The pool of buffers associated with the stream + * + * The stream buffer pool is populated by the Camera class after a succesfull + * stream configuration. + */ + +/** + * \var Stream::configuration_ + * \brief The stream configuration + * + * The configuration for the stream is set by any successful call to + * Camera::configureStreams() that includes the stream, and remains valid until + * the next call to Camera::configureStreams() regardless of if it includes the + * stream. + */ + } /* namespace libcamera */