[PATCH] ipa: libipa: Fix ExposureModeHelper function name in documentation

[Jacopo Mondi]

Hi Laurent

On Mon, Oct 28, 2024 at 03:14:59AM +0200, Laurent Pinchart wrote:
> Previous iterations of the ExposureModeHelper class had a
> setShutterGainLimits() function, which got renamed to setLimits(). The
> documentation still uses the old name. Fix it.
>
> Signed-off-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>

Reviewed-by: Jacopo Mondi <jacopo.mondi at ideasonboard.com>

Thanks
   j
> ---
>  src/ipa/libipa/exposure_mode_helper.cpp | 13 +++++--------
>  1 file changed, 5 insertions(+), 8 deletions(-)
>
> diff --git a/src/ipa/libipa/exposure_mode_helper.cpp b/src/ipa/libipa/exposure_mode_helper.cpp
> index 7703becc4766..30da0c894044 100644
> --- a/src/ipa/libipa/exposure_mode_helper.cpp
> +++ b/src/ipa/libipa/exposure_mode_helper.cpp
> @@ -67,7 +67,7 @@ namespace ipa {
>   * encompasses both analogue and digital gain.
>   *
>   * The vector of stages may be empty. In that case, the helper will simply use
> - * the runtime limits set through setShutterGainLimits() instead.
> + * the runtime limits set through setLimits() instead.
>   */
>  ExposureModeHelper::ExposureModeHelper(const Span<std::pair<utils::Duration, double>> stages)
>  {
> @@ -213,28 +213,25 @@ ExposureModeHelper::splitExposure(utils::Duration exposure) const
>  /**
>   * \fn ExposureModeHelper::minShutter()
>   * \brief Retrieve the configured minimum shutter time limit set through
> - * setShutterGainLimits()
> + * setLimits()
>   * \return The minShutter_ value
>   */
>
>  /**
>   * \fn ExposureModeHelper::maxShutter()
> - * \brief Retrieve the configured maximum shutter time set through
> - * setShutterGainLimits()
> + * \brief Retrieve the configured maximum shutter time set through setLimits()
>   * \return The maxShutter_ value
>   */
>
>  /**
>   * \fn ExposureModeHelper::minGain()
> - * \brief Retrieve the configured minimum gain set through
> - * setShutterGainLimits()
> + * \brief Retrieve the configured minimum gain set through setLimits()
>   * \return The minGain_ value
>   */
>
>  /**
>   * \fn ExposureModeHelper::maxGain()
> - * \brief Retrieve the configured maximum gain set through
> - * setShutterGainLimits()
> + * \brief Retrieve the configured maximum gain set through setLimits()
>   * \return The maxGain_ value
>   */
>
>
> base-commit: 80a7ccd3add45eb56fda6f1fb445017ac01fea7a
> --
> Regards,
>
> Laurent Pinchart
>