[libcamera-devel,2/6] libcamera: signal: Enable documentation generation from signal.h file

282 diff mbox series

signal.cpp is missing a \file signal.h Doxygen directive, preventing
documentation from being generated for the Signal class. Fix it.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 src/libcamera/signal.cpp | 5 +++++
 1 file changed, 5 insertions(+)

Hi Laurent,
   thanks for the series...

For 1 and 2:
Acked-by: Jacopo Mondi <jacopo@jmondi.org>

3-6 will require some more time for me to look at the implementation
better, and possibly use it in practice, but when I thought about what
logging APIs I would have liked to have, they look very similiar to
what's in there.

Thanks
  j

On Mon, Jan 21, 2019 at 02:59:26AM +0200, Laurent Pinchart wrote:
> signal.cpp is missing a \file signal.h Doxygen directive, preventing
> documentation from being generated for the Signal class. Fix it.
>
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> ---
>  src/libcamera/signal.cpp | 5 +++++
>  1 file changed, 5 insertions(+)
>
> diff --git a/src/libcamera/signal.cpp b/src/libcamera/signal.cpp
> index 51536dc5fdd0..8d62b5beeeac 100644
> --- a/src/libcamera/signal.cpp
> +++ b/src/libcamera/signal.cpp
> @@ -5,6 +5,11 @@
>   * signal.cpp - Signal & slot implementation
>   */
>
> +/**
> + * \file signal.h
> + * \brief Signal & slot implementation
> + */
> +
>  namespace libcamera {
>
>  /**
> --
> Regards,
>
> Laurent Pinchart
>
> _______________________________________________
> libcamera-devel mailing list
> libcamera-devel@lists.libcamera.org
> https://lists.libcamera.org/listinfo/libcamera-devel

Hi Laurent,

Thanks for your work.

On 2019-01-21 02:59:26 +0200, Laurent Pinchart wrote:
> signal.cpp is missing a \file signal.h Doxygen directive, preventing
> documentation from being generated for the Signal class. Fix it.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

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

> ---
>  src/libcamera/signal.cpp | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/src/libcamera/signal.cpp b/src/libcamera/signal.cpp
> index 51536dc5fdd0..8d62b5beeeac 100644
> --- a/src/libcamera/signal.cpp
> +++ b/src/libcamera/signal.cpp
> @@ -5,6 +5,11 @@
>   * signal.cpp - Signal & slot implementation
>   */
>  
> +/**
> + * \file signal.h
> + * \brief Signal & slot implementation
> + */
> +
>  namespace libcamera {
>  
>  /**
> -- 
> Regards,
> 
> Laurent Pinchart
> 
> _______________________________________________
> libcamera-devel mailing list
> libcamera-devel@lists.libcamera.org
> https://lists.libcamera.org/listinfo/libcamera-devel