ipa: libipa: Add missing CameraSensorHelper fn label in docs
diff mbox series

Message ID 20240808084415.261894-1-mzamazal@redhat.com
State Accepted
Commit ea7d7668077d26b9117973b80a7e6e431846eda0
Headers show
Series
  • ipa: libipa: Add missing CameraSensorHelper fn label in docs
Related show

Commit Message

Milan Zamazal Aug. 8, 2024, 8:44 a.m. UTC
The constructor reference was missing, causing the constructor
documentation to appear in blackLevel() documentation.

Signed-off-by: Milan Zamazal <mzamazal@redhat.com>
---
 src/ipa/libipa/camera_sensor_helper.cpp | 1 +
 1 file changed, 1 insertion(+)

Comments

Kieran Bingham Aug. 8, 2024, 9:03 a.m. UTC | #1
Quoting Milan Zamazal (2024-08-08 09:44:15)
> The constructor reference was missing, causing the constructor
> documentation to appear in blackLevel() documentation.

Ooops indeed.


Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>

> 
> Signed-off-by: Milan Zamazal <mzamazal@redhat.com>
> ---
>  src/ipa/libipa/camera_sensor_helper.cpp | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/src/ipa/libipa/camera_sensor_helper.cpp b/src/ipa/libipa/camera_sensor_helper.cpp
> index c07b1a8d..ffc7c1d7 100644
> --- a/src/ipa/libipa/camera_sensor_helper.cpp
> +++ b/src/ipa/libipa/camera_sensor_helper.cpp
> @@ -41,6 +41,7 @@ namespace ipa {
>   */
>  
>  /**
> + * \fn CameraSensorHelper::CameraSensorHelper()
>   * \brief Construct a CameraSensorHelper instance
>   *
>   * CameraSensorHelper derived class instances shall never be constructed
> -- 
> 2.44.1
>
Laurent Pinchart Aug. 12, 2024, 12:13 p.m. UTC | #2
Hi Milan,

Thank you for the patch.

On Thu, Aug 08, 2024 at 10:44:15AM +0200, Milan Zamazal wrote:
> The constructor reference was missing, causing the constructor
> documentation to appear in blackLevel() documentation.
> 
> Signed-off-by: Milan Zamazal <mzamazal@redhat.com>

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

> ---
>  src/ipa/libipa/camera_sensor_helper.cpp | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/src/ipa/libipa/camera_sensor_helper.cpp b/src/ipa/libipa/camera_sensor_helper.cpp
> index c07b1a8d..ffc7c1d7 100644
> --- a/src/ipa/libipa/camera_sensor_helper.cpp
> +++ b/src/ipa/libipa/camera_sensor_helper.cpp
> @@ -41,6 +41,7 @@ namespace ipa {
>   */
>  
>  /**
> + * \fn CameraSensorHelper::CameraSensorHelper()
>   * \brief Construct a CameraSensorHelper instance
>   *
>   * CameraSensorHelper derived class instances shall never be constructed

Patch
diff mbox series

diff --git a/src/ipa/libipa/camera_sensor_helper.cpp b/src/ipa/libipa/camera_sensor_helper.cpp
index c07b1a8d..ffc7c1d7 100644
--- a/src/ipa/libipa/camera_sensor_helper.cpp
+++ b/src/ipa/libipa/camera_sensor_helper.cpp
@@ -41,6 +41,7 @@  namespace ipa {
  */
 
 /**
+ * \fn CameraSensorHelper::CameraSensorHelper()
  * \brief Construct a CameraSensorHelper instance
  *
  * CameraSensorHelper derived class instances shall never be constructed