[libcamera-devel] [PATCH] libcamera: camera_sensor: Fix doxygen warning

[Kieran Bingham]

Quoting Laurent Pinchart (2021-12-03 11:05:27)
> Commit ad2bcbe5b55c ("libcamera: camera_lens: add CameraLens as a member
> of CameraSensor") incorrectly named the focusLens() function
> "focusLens_" in the documentation, causing a doxygen warning. Fix it.
> 
> Fixes: ad2bcbe5b55c ("libcamera: camera_lens: add CameraLens as a member of CameraSensor")
> Signed-off-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>


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

> ---
> Han-lin, could you please make sure to have a look for doxygen warnings
> in future patches ? We'll also update our integration scripts to detect
> them.

Yes, sorry - looking at the logs it got flagged up  - but doesn't cause
a fatal stop, so it didn't trap, and I missed it.

I'll have to figure out how to make doxygen -Werror ... ?

--
Kieran


> ---
>  src/libcamera/camera_sensor.cpp | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/src/libcamera/camera_sensor.cpp b/src/libcamera/camera_sensor.cpp
> index c89d39e1488c..4c142a5825f7 100644
> --- a/src/libcamera/camera_sensor.cpp
> +++ b/src/libcamera/camera_sensor.cpp
> @@ -789,7 +789,7 @@ void CameraSensor::updateControlInfo()
>  }
>  
>  /**
> - * \fn CameraSensor::focusLens_()
> + * \fn CameraSensor::focusLens()
>   * \brief Retrieve the focus lens controller
>   *
>   * \return The focus lens controller. nullptr if no focus lens controller is
> 
> base-commit: 3f881dbc338e8f24f478567ee890c1f36ccb8996
> -- 
> Regards,
> 
> Laurent Pinchart
>