[libcamera-devel] [RFC PATCH 05/17] Documentation: Doxygen: Don't exclude Private classes

Niklas Söderlund niklas.soderlund at ragnatech.se
Sat Jul 24 08:58:49 CEST 2021


Hi Laurent,

Thanks for your work.

On 2021-07-23 07:00:24 +0300, Laurent Pinchart wrote:
> Some of the libcamera Private classes are part of the internal API
> exposed to pipeline handlers, and should thus be documented as such.
> Drop the wildcard exclusion, and exclude fully private classes
> explicitly instead.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>
> ---
>  Documentation/Doxyfile.in | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in
> index a79d37706faf..aee5c9fd7e59 100644
> --- a/Documentation/Doxyfile.in
> +++ b/Documentation/Doxyfile.in
> @@ -882,8 +882,9 @@ EXCLUDE_SYMBOLS        = libcamera::BoundMethodArgs \
>                           libcamera::BoundMethodPack \
>                           libcamera::BoundMethodPackBase \
>                           libcamera::BoundMethodStatic \
> +			 libcamera::Camera::Private \
> +			 libcamera::CameraManager::Private \

This adds indentation by tabs while the context is spaces. Not sure what 
is correct but if they are updated to match,

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

>                           libcamera::SignalBase \
> -                         libcamera::*::Private \
>                           *::details \
>                           std::*
>  
> -- 
> Regards,
> 
> Laurent Pinchart
> 

-- 
Regards,
Niklas Söderlund


More information about the libcamera-devel mailing list