ipa: libipa: camera_sensor_helper: Reference blackLevel() in documentation
diff mbox series

Message ID 20240803213004.23410-1-laurent.pinchart@ideasonboard.com
State Accepted
Commit 46275401e6e68c750e5fa4cce77731ee0fd35172
Headers show
Series
  • ipa: libipa: camera_sensor_helper: Reference blackLevel() in documentation
Related show

Commit Message

Laurent Pinchart Aug. 3, 2024, 9:30 p.m. UTC
The documentation for the blackLevel_ member is very terse. Reference
the more complete documentation of the sibling blackLevel() member
function to provide more information.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 src/ipa/libipa/camera_sensor_helper.cpp | 1 +
 1 file changed, 1 insertion(+)


base-commit: 19bbca3c0b376ba0183f5db53472c8c46cd402b5

Comments

Milan Zamazal Aug. 5, 2024, 9:31 a.m. UTC | #1
Laurent Pinchart <laurent.pinchart@ideasonboard.com> writes:

> The documentation for the blackLevel_ member is very terse. Reference
> the more complete documentation of the sibling blackLevel() member
> function to provide more information.
>
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

Reviewed-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 2f6e7282ad7f..c07b1a8dcaec 100644
> --- a/src/ipa/libipa/camera_sensor_helper.cpp
> +++ b/src/ipa/libipa/camera_sensor_helper.cpp
> @@ -235,6 +235,7 @@ double CameraSensorHelper::gain(uint32_t gainCode) const
>  /**
>   * \var CameraSensorHelper::blackLevel_
>   * \brief The black level of the sensor
> + * \sa CameraSensorHelper::blackLevel()
>   */
>  
>  /**
>
> base-commit: 19bbca3c0b376ba0183f5db53472c8c46cd402b5
Kieran Bingham Aug. 5, 2024, 11:34 a.m. UTC | #2
Quoting Milan Zamazal (2024-08-05 10:31:07)
> Laurent Pinchart <laurent.pinchart@ideasonboard.com> writes:
> 
> > The documentation for the blackLevel_ member is very terse. Reference
> > the more complete documentation of the sibling blackLevel() member
> > function to provide more information.
> >
> > Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> 
> Reviewed-by: Milan Zamazal <mzamazal@redhat.com>

Reviewed-by: Kieran Bingham <kieran.bingham@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 2f6e7282ad7f..c07b1a8dcaec 100644
> > --- a/src/ipa/libipa/camera_sensor_helper.cpp
> > +++ b/src/ipa/libipa/camera_sensor_helper.cpp
> > @@ -235,6 +235,7 @@ double CameraSensorHelper::gain(uint32_t gainCode) const
> >  /**
> >   * \var CameraSensorHelper::blackLevel_
> >   * \brief The black level of the sensor
> > + * \sa CameraSensorHelper::blackLevel()
> >   */
> >  
> >  /**
> >
> > base-commit: 19bbca3c0b376ba0183f5db53472c8c46cd402b5
>

Patch
diff mbox series

diff --git a/src/ipa/libipa/camera_sensor_helper.cpp b/src/ipa/libipa/camera_sensor_helper.cpp
index 2f6e7282ad7f..c07b1a8dcaec 100644
--- a/src/ipa/libipa/camera_sensor_helper.cpp
+++ b/src/ipa/libipa/camera_sensor_helper.cpp
@@ -235,6 +235,7 @@  double CameraSensorHelper::gain(uint32_t gainCode) const
 /**
  * \var CameraSensorHelper::blackLevel_
  * \brief The black level of the sensor
+ * \sa CameraSensorHelper::blackLevel()
  */
 
 /**