[PATCH v1] Documentation: Fix `INCLUDE_PATH` doxygen configuration option

[Laurent Pinchart]

Hi Barnabás,

Thank you for the patch.

On Mon, May 26, 2025 at 02:03:55PM +0200, Barnabás Pőcze wrote:
> libcamera header files should be included using the `libcamera/...` prefix.
> However, `INCLUDE_PATH` is currently set to `@TOP_SRCDIR@/include/libcamera`
> meaning that doxygen, when encountering `libcamera/x.h`, will try to open
> `@TOP_SRCDIR@/include/libcamera/libcamera/x.h`, which is not the correct
> path.
> 
> Fix that by using `@TOP_{BUILD,SRC}DIR@/include`. This removes the extra
> `libcamera` component from the path and adds the corresponding directory
> from the build directory as well since that is an implicit include
> directory added by meson.

Generating documentation from files in the build directory isn't very
nice, as doxygen will list build directory names in the generated HTML.
We should fix it at some point, but that's an existing issue that isn't
introduced by this patch, so

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

> Signed-off-by: Barnabás Pőcze <barnabas.pocze at ideasonboard.com>
> ---
>  Documentation/Doxyfile-common.in | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/Doxyfile-common.in b/Documentation/Doxyfile-common.in
> index 045c19dd6..58afea1cd 100644
> --- a/Documentation/Doxyfile-common.in
> +++ b/Documentation/Doxyfile-common.in
> @@ -57,7 +57,8 @@ GENERATE_LATEX         = NO
>  MACRO_EXPANSION        = YES
>  EXPAND_ONLY_PREDEF     = YES
>  
> -INCLUDE_PATH           = "@TOP_SRCDIR@/include/libcamera"
> +INCLUDE_PATH           = "@TOP_BUILDDIR@/include" \
> +                         "@TOP_SRCDIR@/include"
>  INCLUDE_FILE_PATTERNS  = *.h
>  
>  IMAGE_PATH             = "@TOP_SRCDIR@/Documentation/images"

-- 
Regards,

Laurent Pinchart