[libcamera-devel,RFC,05/17] Documentation: Doxygen: Don't exclude Private classes
diff mbox series

Message ID 20210723040036.32346-6-laurent.pinchart@ideasonboard.com
State Accepted
Headers show
Series
  • libcamera: Replace CameraData with Camera::Private
Related show

Commit Message

Laurent Pinchart July 23, 2021, 4 a.m. UTC
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@ideasonboard.com>
---
 Documentation/Doxyfile.in | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

Comments

Niklas Söderlund July 24, 2021, 6:58 a.m. UTC | #1
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@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@ragnatech.se>

>                           libcamera::SignalBase \
> -                         libcamera::*::Private \
>                           *::details \
>                           std::*
>  
> -- 
> Regards,
> 
> Laurent Pinchart
>
Laurent Pinchart July 24, 2021, 6:55 p.m. UTC | #2
Hi Niklas,

On Sat, Jul 24, 2021 at 08:58:49AM +0200, Niklas Söderlund wrote:
> 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@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,

Oops. Will fix.

> Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>
> 
> >                           libcamera::SignalBase \
> > -                         libcamera::*::Private \
> >                           *::details \
> >                           std::*
> >
Jacopo Mondi July 29, 2021, 8:40 p.m. UTC | #3
Hi Laurent,

On Fri, Jul 23, 2021 at 07:00:24AM +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@ideasonboard.com>

With the space/tab conversion reported by Niklas

Reviewed-by: Jacopo Mondi <jacopo@jmondi.org>

Thanks
  j
> ---
>  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 \
>                           libcamera::SignalBase \
> -                         libcamera::*::Private \
>                           *::details \
>                           std::*
>
> --
> Regards,
>
> Laurent Pinchart
>

Patch
diff mbox series

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 \
                          libcamera::SignalBase \
-                         libcamera::*::Private \
                          *::details \
                          std::*