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

Message ID 20190205171010.1356-2-jacopo@jmondi.org
State Superseded
Delegated to: Jacopo Mondi
Headers show
Series
  • Add v4l2 subdevice
Related show

Commit Message

Jacopo Mondi Feb. 5, 2019, 5:10 p.m. UTC
Please the doxygen overlord!

Signed-off-by: Jacopo Mondi <jacopo@jmondi.org>
---
 src/libcamera/v4l2_device.cpp | 3 +++
 1 file changed, 3 insertions(+)

Comments

Niklas Söderlund Feb. 5, 2019, 6:30 p.m. UTC | #1
Hi Jacopo,

Thanks for your patch.

On 2019-02-05 18:10:08 +0100, Jacopo Mondi wrote:
> Please the doxygen overlord!

I would use a slightly more descriptive commit message. However I'm sure 
the Doxygen overloard is happy for the attention :-)

> 
> Signed-off-by: Jacopo Mondi <jacopo@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

s/format format/format/

With these two issues fixed,

Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>

>   *
>   * Apply the supplied \a format to the device, and return the actually
>   * applied format parameters, as \ref V4L2Device::getFormat would do.
> -- 
> 2.20.1
> 
> _______________________________________________
> libcamera-devel mailing list
> libcamera-devel@lists.libcamera.org
> https://lists.libcamera.org/listinfo/libcamera-devel

Patch

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.