[libcamera-devel,10/27] libcamera: v4l2_device: Add comments to method parameters
diff mbox series

Message ID 20190206060818.13907-11-laurent.pinchart@ideasonboard.com
State Accepted
Headers show
Series
  • Capture frames throught requests
Related show

Commit Message

Laurent Pinchart Feb. 6, 2019, 6:08 a.m. UTC 
From: Jacopo Mondi <jacopo@jmondi.org>

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>
---
 src/libcamera/v4l2_device.cpp | 3 +++
 1 file changed, 3 insertions(+)

Patch
diff mbox series 

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.