From patchwork Thu Apr 18 15:18: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: 1061 Return-Path: Received: from relay8-d.mail.gandi.net (relay8-d.mail.gandi.net [217.70.183.201]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 4DFFF60DBE for ; Thu, 18 Apr 2019 17:17:37 +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 relay8-d.mail.gandi.net (Postfix) with ESMTPSA id D2A321BF213; Thu, 18 Apr 2019 15:17:36 +0000 (UTC) From: Jacopo Mondi To: libcamera-devel@lists.libcamera.org Date: Thu, 18 Apr 2019 17:18:24 +0200 Message-Id: <20190418151824.30127-1-jacopo@jmondi.org> X-Mailer: git-send-email 2.21.0 MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH] 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: Thu, 18 Apr 2019 15:17:37 -0000 Since commit: 4e1dc9004fca ("libcamera: stream: Make Stream inheritable") the private members of the Stream class have been turned into protected, to allows sub-class to access them. As Doxygen generates documentation for protected members (but not private ones), add documentation to the stream class for the 'bufferMap_' and 'configuration_' members. Fixes: 4e1dc9004fca ("libcamera: stream: Make Stream inheritable") Signed-off-by: Jacopo Mondi --- src/libcamera/stream.cpp | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/src/libcamera/stream.cpp b/src/libcamera/stream.cpp index 85cd5256ee2f..5839b983f45f 100644 --- a/src/libcamera/stream.cpp +++ b/src/libcamera/stream.cpp @@ -194,4 +194,21 @@ 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 configuration associated with the stream + * + * The stream configuration is accessible only to Stream sub-classes and to + * the Camera class, that associates the Stream with the configuration returned + * by a succesfull PipelineHandler::configureStreams() call. + */ + } /* namespace libcamera */