[07/19] libcamera: software_isp: Remove dots in Debayer::process docstring
diff mbox series

Message ID 20240626072100.55497-8-mzamazal@redhat.com
State New
Headers show
Series
  • Software ISP refactoring
Related show

Commit Message

Milan Zamazal June 26, 2024, 7:20 a.m. UTC
Signed-off-by: Milan Zamazal <mzamazal@redhat.com>
---
 src/libcamera/software_isp/debayer.cpp | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

Comments

Umang Jain June 28, 2024, 3:49 a.m. UTC | #1
HI Milan

On 26/06/24 12:50 pm, Milan Zamazal wrote:
> Signed-off-by: Milan Zamazal <mzamazal@redhat.com>
> ---
>   src/libcamera/software_isp/debayer.cpp | 11 ++++++-----
>   1 file changed, 6 insertions(+), 5 deletions(-)
>
> diff --git a/src/libcamera/software_isp/debayer.cpp b/src/libcamera/software_isp/debayer.cpp
> index f4a299d5..65fc4efc 100644
> --- a/src/libcamera/software_isp/debayer.cpp
> +++ b/src/libcamera/software_isp/debayer.cpp
> @@ -94,11 +94,12 @@ Debayer::~Debayer()
>    */
>   
>   /**
> - * \fn void Debayer::process(FrameBuffer *input, FrameBuffer *output, DebayerParams params)
> - * \brief Process the bayer data into the requested format.
> - * \param[in] input The input buffer.
> - * \param[in] output The output buffer.
> - * \param[in] params The parameters to be used in debayering.
> + * \fn void Debayer::process(uint32_t frame, FrameBuffer *input, FrameBuffer *output, DebayerParams params)

I believe the change in arguments (i.e. frame) belongs to your next 
patch 08/19.
> + * \brief Process the bayer data into the requested format
> + * \param[in] frame The frame number
> + * \param[in] input The input buffer
> + * \param[in] output The output buffer
> + * \param[in] params The parameters to be used in debayering
>    *
>    * \note DebayerParams is passed by value deliberately so that a copy is passed
>    * when this is run in another thread by invokeMethod().

Patch
diff mbox series

diff --git a/src/libcamera/software_isp/debayer.cpp b/src/libcamera/software_isp/debayer.cpp
index f4a299d5..65fc4efc 100644
--- a/src/libcamera/software_isp/debayer.cpp
+++ b/src/libcamera/software_isp/debayer.cpp
@@ -94,11 +94,12 @@  Debayer::~Debayer()
  */
 
 /**
- * \fn void Debayer::process(FrameBuffer *input, FrameBuffer *output, DebayerParams params)
- * \brief Process the bayer data into the requested format.
- * \param[in] input The input buffer.
- * \param[in] output The output buffer.
- * \param[in] params The parameters to be used in debayering.
+ * \fn void Debayer::process(uint32_t frame, FrameBuffer *input, FrameBuffer *output, DebayerParams params)
+ * \brief Process the bayer data into the requested format
+ * \param[in] frame The frame number
+ * \param[in] input The input buffer
+ * \param[in] output The output buffer
+ * \param[in] params The parameters to be used in debayering
  *
  * \note DebayerParams is passed by value deliberately so that a copy is passed
  * when this is run in another thread by invokeMethod().