[libcamera-devel] [PATCH 1/3] libcamera: v4l2_device: Add method parameters comment

Jacopo Mondi jacopo at jmondi.org
Tue Feb 5 18:10:08 CET 2019


Please the doxygen overlord!

Signed-off-by: Jacopo Mondi <jacopo at jmondi.org>
---
 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.
-- 
2.20.1



More information about the libcamera-devel mailing list