summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorJacopo Mondi <jacopo@jmondi.org>2019-02-05 17:58:20 +0100
committerLaurent Pinchart <laurent.pinchart@ideasonboard.com>2019-02-06 07:41:39 +0200
commit8628b1e5600a82f280bac5585083da4ca1a315df (patch)
tree5b878029fe26f4ea6634ac5be33fed35e7f0ad17 /src
parente94e52c0cb27f92c085da6e776af8b3d3172bbb2 (diff)
libcamera: v4l2_device: Add comments to method parameters
Add missing parameter documentation for set and get format methods. Signed-off-by: Jacopo Mondi <jacopo@jmondi.org> Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se> Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Diffstat (limited to 'src')
-rw-r--r--src/libcamera/v4l2_device.cpp3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/libcamera/v4l2_device.cpp b/src/libcamera/v4l2_device.cpp
index e8755be1..64325ff9 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.