From patchwork Tue Feb 5 17:10:08 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Jacopo Mondi X-Patchwork-Id: 512 X-Patchwork-Delegate: jacopo@jmondi.org Return-Path: Received: from relay1-d.mail.gandi.net (relay1-d.mail.gandi.net [217.70.183.193]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 98EB660DC2 for ; Tue, 5 Feb 2019 18:09:59 +0100 (CET) X-Originating-IP: 81.164.19.127 Received: from uno.localdomain (d51A4137F.access.telenet.be [81.164.19.127]) (Authenticated sender: jacopo@jmondi.org) by relay1-d.mail.gandi.net (Postfix) with ESMTPSA id 21582240007; Tue, 5 Feb 2019 17:09:58 +0000 (UTC) From: Jacopo Mondi To: libcamera-devel@lists.libcamera.org Date: Tue, 5 Feb 2019 18:10:08 +0100 Message-Id: <20190205171010.1356-2-jacopo@jmondi.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190205171010.1356-1-jacopo@jmondi.org> References: <20190205171010.1356-1-jacopo@jmondi.org> MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH 1/3] libcamera: v4l2_device: Add method parameters comment 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: Tue, 05 Feb 2019 17:10:00 -0000 Please the doxygen overlord! Signed-off-by: Jacopo Mondi Reviewed-by: Niklas Söderlund --- 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 1823457..3cecfc8 100644 --- a/src/libcamera/v4l2_device.cpp +++ b/src/libcamera/v4l2_device.cpp @@ -329,6 +329,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) @@ -339,6 +341,7 @@ int V4L2Device::getFormat(V4L2DeviceFormat *format) /** * \brief Configure an image format on the V4L2 device + * \param[in] format 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.