From patchwork Fri Jan 25 17:03:59 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jacopo Mondi X-Patchwork-Id: 391 Return-Path: Received: from relay12.mail.gandi.net (relay12.mail.gandi.net [217.70.178.232]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id C961960C7F for ; Fri, 25 Jan 2019 18:04:12 +0100 (CET) Received: from uno.lan (2-224-242-101.ip172.fastwebnet.it [2.224.242.101]) (Authenticated sender: jacopo@jmondi.org) by relay12.mail.gandi.net (Postfix) with ESMTPSA id 621B220000C; Fri, 25 Jan 2019 17:04:12 +0000 (UTC) From: Jacopo Mondi To: libcamera-devel@lists.libcamera.org Date: Fri, 25 Jan 2019 18:03:59 +0100 Message-Id: <20190125170400.24821-5-jacopo@jmondi.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190125170400.24821-1-jacopo@jmondi.org> References: <20190125170400.24821-1-jacopo@jmondi.org> MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH 4/5] libcamera: pipeline: Misc comments update 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, 25 Jan 2019 17:04:13 -0000 Apply some comments improvements pointed out during review. Signed-off-by: Jacopo Mondi --- src/libcamera/pipeline_handler.cpp | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp index e75bf0f..dc55f8f 100644 --- a/src/libcamera/pipeline_handler.cpp +++ b/src/libcamera/pipeline_handler.cpp @@ -100,7 +100,7 @@ PipelineHandler::~PipelineHandler() * one pipeline instance, until all compatible media devices are exhausted. * * If this function returns true, a new instance of the pipeline handler will - * be created and its match() function called, + * be created and its match() function called. * * \return true if media devices have been acquired and camera instances * created, or false otherwise @@ -184,11 +184,12 @@ void PipelineHandler::mediaDeviceDisconnected(MediaDevice *media) /** * \brief Retrieve the pipeline-specific data associated with a Camera - * \param camera The camera data is associate with + * \param camera The camera whose data to retrieve * * \return A pointer to the pipeline-specific data set with setCameraData(). - * The returned pointer lifetime is associated with the one of the pipeline - * handler, and caller of this function shall never release it manually. + * The returned pointer is a borrowed reference and is guaranteed to remain + * valid until the pipeline handler is destroyed. It shall not be deleted + * manually by the caller. */ CameraData *PipelineHandler::cameraData(const Camera *camera) { @@ -203,13 +204,13 @@ CameraData *PipelineHandler::cameraData(const Camera *camera) } /** - * \brief Set pipeline-specific data in the camera + * \brief Set pipeline-specific data for the camera * \param camera The camera to associate data to * \param data The pipeline-specific data * * This method allows pipeline handlers to associate pipeline-specific - * information with \a camera. The \a data lifetime gets associated with - * the pipeline handler one, and gets released at deletion time. + * information with \a camera. Ownership of \a data is transferred to + * the PipelineHandler. * * If pipeline-specific data has already been associated with the camera by a * previous call to this method, is it replaced by \a data and the previous data