[libcamera-devel] [PATCH] Documentation: Fix Doxygen exclusion of details namespaces

[Niklas Söderlund]

Hi Laurent,

Thanks for your work.

On 2020-12-27 11:47:56 +0200, Laurent Pinchart wrote:
> The details namespaces in libcamera are used to hide implementation
> details, and should thus be excluded from documentation generation. This
> is done incorrectly by specifying the exclusion pattern "*::details::*"
> which will ignore all namespaces and types in any details namespace, but
> won't ignore functions. Fix it by removing the trailing "::*", causing
> Doxygen to ignore the namespace itself, and thus all its contents.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>

Reviewed-by: Niklas Söderlund <niklas.soderlund at ragnatech.se>

> ---
>  Documentation/Doxyfile.in | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in
> index c986fb6ab899..dc76cbeab335 100644
> --- a/Documentation/Doxyfile.in
> +++ b/Documentation/Doxyfile.in
> @@ -877,7 +877,7 @@ EXCLUDE_SYMBOLS        = libcamera::BoundMethodArgs \
>                           libcamera::BoundMethodStatic \
>                           libcamera::SignalBase \
>                           libcamera::*::Private \
> -                         *::details::* \
> +                         *::details \
>                           std::*
>  
>  # The EXAMPLE_PATH tag can be used to specify one or more files or directories
> -- 
> Regards,
> 
> Laurent Pinchart
> 
> _______________________________________________
> libcamera-devel mailing list
> libcamera-devel at lists.libcamera.org
> https://lists.libcamera.org/listinfo/libcamera-devel

-- 
Regards,
Niklas Söderlund