From patchwork Wed Feb 6 06:08:01 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Laurent Pinchart X-Patchwork-Id: 525 Return-Path: Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id B708A61020 for ; Wed, 6 Feb 2019 07:08:25 +0100 (CET) Received: from pendragon.ideasonboard.com (d51A4137F.access.telenet.be [81.164.19.127]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 6065A2D8 for ; Wed, 6 Feb 2019 07:08:25 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1549433305; bh=ed7zAfnTyKzgGDl6z7BGBCASUoPoQdL+D+VYDrRhisM=; h=From:To:Subject:Date:In-Reply-To:References:From; b=FnYWRaoE4hQt4oOWkrW4PRyq1W3TqUVBrz10DJkqKO8xgtOduSaXWLevrL2eMIMWQ NW7lOZMICxRlyCihvM5JUywlwHnSZlDKp7aUccMp9FQeNpqFNvQUy0G82XPCerDrLD bIRkQsVpmkucdp9GGMMU93/VyQV3RfBWVmznHXn0= From: Laurent Pinchart To: libcamera-devel@lists.libcamera.org Date: Wed, 6 Feb 2019 08:08:01 +0200 Message-Id: <20190206060818.13907-11-laurent.pinchart@ideasonboard.com> X-Mailer: git-send-email 2.19.2 In-Reply-To: <20190206060818.13907-1-laurent.pinchart@ideasonboard.com> References: <20190206060818.13907-1-laurent.pinchart@ideasonboard.com> MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH 10/27] libcamera: v4l2_device: Add comments to method parameters 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: Wed, 06 Feb 2019 06:08:27 -0000 From: Jacopo Mondi Add missing parameter documentation for set and get format methods. Signed-off-by: Jacopo Mondi Reviewed-by: Niklas Söderlund Reviewed-by: Kieran Bingham Reviewed-by: Laurent Pinchart Signed-off-by: Laurent Pinchart --- src/libcamera/v4l2_device.cpp | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/libcamera/v4l2_device.cpp b/src/libcamera/v4l2_device.cpp index e8755be1f63f..64325ff9f5d9 100644 --- a/src/libcamera/v4l2_device.cpp +++ b/src/libcamera/v4l2_device.cpp @@ -352,6 +352,8 @@ void V4L2Device::close() /** * \brief Retrieve the image format set on the V4L2 device + * \param[out] format The image format applied on the device + * * \return 0 for success, a negative error code otherwise */ int V4L2Device::getFormat(V4L2DeviceFormat *format) @@ -362,6 +364,7 @@ int V4L2Device::getFormat(V4L2DeviceFormat *format) /** * \brief Configure an image format on the V4L2 device + * \param[in] format The image format to apply to the device * * Apply the supplied \a format to the device, and return the actually * applied format parameters, as \ref V4L2Device::getFormat would do.