[libcamera-devel,3/3] libcamera: geometry: Fix SizeRange constructor style

Message ID 20190610220759.7192-3-kieran.bingham@ideasonboard.com
State Accepted
Commit c544506e1ad85e21f90ddaf4fe6c75975e8234a1
Headers show
Series
  • [libcamera-devel,1/3] libcamera: pipeline: Fix 'request' grammar
Related show

Commit Message

Kieran Bingham June 10, 2019, 10:07 p.m. UTC
Match the style of the SizeRange() which specifies the hStep and vStep,
and wrap the lines in pairs of min and max values.

Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
---
 src/libcamera/geometry.cpp | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

Comments

Jacopo Mondi June 11, 2019, 6:06 a.m. UTC | #1
Hi Kieran,

On Mon, Jun 10, 2019 at 11:07:59PM +0100, Kieran Bingham wrote:
> Match the style of the SizeRange() which specifies the hStep and vStep,
> and wrap the lines in pairs of min and max values.
>
> Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
> ---
>  src/libcamera/geometry.cpp | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/src/libcamera/geometry.cpp b/src/libcamera/geometry.cpp
> index 97c367bcb454..fb8f628a0d8a 100644
> --- a/src/libcamera/geometry.cpp
> +++ b/src/libcamera/geometry.cpp
> @@ -197,7 +197,8 @@ bool operator<(const Size &lhs, const Size &rhs)
>   */
>
>  /**
> - * \fn SizeRange::SizeRange(unsigned int minW, unsigned int minH, unsigned int maxW, unsigned int maxH)
> + * \fn SizeRange::SizeRange(unsigned int minW, unsigned int minH,
> + *			    unsigned int maxW, unsigned int maxH)

I was not sure Doxygen interpret line break correctly.
I have generated the doc and it seems it does!

Thanks
Reviewed-by: Jacopo Mondi <jacopo@jmondi.org>

>   * \brief Construct an initialized size range
>   * \param[in] minW The minimum width
>   * \param[in] minH The minimum height
> --
> 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/geometry.cpp b/src/libcamera/geometry.cpp
index 97c367bcb454..fb8f628a0d8a 100644
--- a/src/libcamera/geometry.cpp
+++ b/src/libcamera/geometry.cpp
@@ -197,7 +197,8 @@  bool operator<(const Size &lhs, const Size &rhs)
  */
 
 /**
- * \fn SizeRange::SizeRange(unsigned int minW, unsigned int minH, unsigned int maxW, unsigned int maxH)
+ * \fn SizeRange::SizeRange(unsigned int minW, unsigned int minH,
+ *			    unsigned int maxW, unsigned int maxH)
  * \brief Construct an initialized size range
  * \param[in] minW The minimum width
  * \param[in] minH The minimum height