[PATCH v5 02/18] libcamera: Make all internal headers visible to Doxygen

[Dan Scally]

Hi Laurent

On 05/08/2024 15:36, Laurent Pinchart wrote:
> Two classes that have both public and internal headers, namely Camera
> and Request, make only their public header visible to Doxygen through a
> file directive. Fix them.
>
> Signed-off-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>


Reviewed-by: Daniel Scally <dan.scally at ideasonboard.com>


How did you notice this, out of curiosity? I never saw any Doxygen messages about it.

> ---
>   src/libcamera/camera.cpp  | 5 +++++
>   src/libcamera/request.cpp | 5 +++++
>   2 files changed, 10 insertions(+)
>
> diff --git a/src/libcamera/camera.cpp b/src/libcamera/camera.cpp
> index 67f3490133b2..f89510ea0472 100644
> --- a/src/libcamera/camera.cpp
> +++ b/src/libcamera/camera.cpp
> @@ -117,6 +117,11 @@
>    * of view is affected by the pipeline.
>    */
>   
> +/**
> + * \file libcamera/internal/camera.h
> + * \brief Internal camera device handling
> + */
> +
>   namespace libcamera {
>   
>   LOG_DECLARE_CATEGORY(Camera)
> diff --git a/src/libcamera/request.cpp b/src/libcamera/request.cpp
> index cfb451e908da..fdf12c1e9088 100644
> --- a/src/libcamera/request.cpp
> +++ b/src/libcamera/request.cpp
> @@ -28,6 +28,11 @@
>    * \brief Describes a frame capture request to be processed by a camera
>    */
>   
> +/**
> + * \file libcamera/internal/request.h
> + * \brief Internal support for request handling
> + */
> +
>   namespace libcamera {
>   
>   LOG_DEFINE_CATEGORY(Request)