[libcamera-devel,3/5] libcamera: Place doxygen \file block above namespace
diff mbox series

Message ID 20201020000310.3008-4-laurent.pinchart@ideasonboard.com
State Accepted
Delegated to: Laurent Pinchart
Headers show
Series
  • libcamera: Miscellaneous documentation fixes
Related show

Commit Message

Laurent Pinchart Oct. 20, 2020, 12:03 a.m. UTC 
Make the whole code base consistent by placing the doxygen \file block
above the libcamera namespace opening. There's a single offender, and
two locations in which a white line is missing.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 src/libcamera/byte_stream_buffer.cpp | 8 ++++----
 src/libcamera/v4l2_pixelformat.cpp   | 1 +
 src/libcamera/v4l2_videodevice.cpp   | 1 +
 3 files changed, 6 insertions(+), 4 deletions(-)

Comments

Paul Elder Oct. 20, 2020, 2:54 a.m. UTC | #1 
Hi Laurent,

On Tue, Oct 20, 2020 at 03:03:08AM +0300, Laurent Pinchart wrote:
> Make the whole code base consistent by placing the doxygen \file block
> above the libcamera namespace opening. There's a single offender, and
> two locations in which a white line is missing.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

Reviewed-by: Paul Elder <paul.elder@ideasonboard.com>

> ---
>  src/libcamera/byte_stream_buffer.cpp | 8 ++++----
>  src/libcamera/v4l2_pixelformat.cpp   | 1 +
>  src/libcamera/v4l2_videodevice.cpp   | 1 +
>  3 files changed, 6 insertions(+), 4 deletions(-)
> 
> diff --git a/src/libcamera/byte_stream_buffer.cpp b/src/libcamera/byte_stream_buffer.cpp
> index df7029b02a7f..eb9003927266 100644
> --- a/src/libcamera/byte_stream_buffer.cpp
> +++ b/src/libcamera/byte_stream_buffer.cpp
> @@ -12,15 +12,15 @@
>  
>  #include "libcamera/internal/log.h"
>  
> -namespace libcamera {
> -
> -LOG_DEFINE_CATEGORY(Serialization);
> -
>  /**
>   * \file byte_stream_buffer.h
>   * \brief Managed memory container for serialized data
>   */
>  
> +namespace libcamera {
> +
> +LOG_DEFINE_CATEGORY(Serialization);
> +
>  /**
>   * \class ByteStreamBuffer
>   * \brief Wrap a memory buffer and provide sequential data read and write
> diff --git a/src/libcamera/v4l2_pixelformat.cpp b/src/libcamera/v4l2_pixelformat.cpp
> index 6b05909f56ae..03ab085c1231 100644
> --- a/src/libcamera/v4l2_pixelformat.cpp
> +++ b/src/libcamera/v4l2_pixelformat.cpp
> @@ -22,6 +22,7 @@
>   * \file v4l2_pixelformat.h
>   * \brief V4L2 Pixel Format
>   */
> +
>  namespace libcamera {
>  
>  LOG_DECLARE_CATEGORY(V4L2)
> diff --git a/src/libcamera/v4l2_videodevice.cpp b/src/libcamera/v4l2_videodevice.cpp
> index 508522ef42bb..16162e1edba3 100644
> --- a/src/libcamera/v4l2_videodevice.cpp
> +++ b/src/libcamera/v4l2_videodevice.cpp
> @@ -32,6 +32,7 @@
>   * \file v4l2_videodevice.h
>   * \brief V4L2 Video Device
>   */
> +
>  namespace libcamera {
>  
>  LOG_DECLARE_CATEGORY(V4L2)
> -- 
> Regards,
> 
> Laurent Pinchart
> 
> _______________________________________________
> libcamera-devel mailing list
> libcamera-devel@lists.libcamera.org
> https://lists.libcamera.org/listinfo/libcamera-devel
Umang Jain Oct. 20, 2020, 3:48 a.m. UTC | #2 
Hi Laurent,

Thank you for the patch.

On 10/20/20 5:33 AM, Laurent Pinchart wrote:
> Make the whole code base consistent by placing the doxygen \file block
> above the libcamera namespace opening. There's a single offender, and
> two locations in which a white line is missing.
>
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
LGTM. I found src/libcamera/utils.cpp to be a bit-special but seems OK 
to me. It would help you can double check it too.
Reviewed-by: Umang Jain <email@uajain.com>
> ---
>   src/libcamera/byte_stream_buffer.cpp | 8 ++++----
>   src/libcamera/v4l2_pixelformat.cpp   | 1 +
>   src/libcamera/v4l2_videodevice.cpp   | 1 +
>   3 files changed, 6 insertions(+), 4 deletions(-)
>
> diff --git a/src/libcamera/byte_stream_buffer.cpp b/src/libcamera/byte_stream_buffer.cpp
> index df7029b02a7f..eb9003927266 100644
> --- a/src/libcamera/byte_stream_buffer.cpp
> +++ b/src/libcamera/byte_stream_buffer.cpp
> @@ -12,15 +12,15 @@
>   
>   #include "libcamera/internal/log.h"
>   
> -namespace libcamera {
> -
> -LOG_DEFINE_CATEGORY(Serialization);
> -
>   /**
>    * \file byte_stream_buffer.h
>    * \brief Managed memory container for serialized data
>    */
>   
> +namespace libcamera {
> +
> +LOG_DEFINE_CATEGORY(Serialization);
> +
>   /**
>    * \class ByteStreamBuffer
>    * \brief Wrap a memory buffer and provide sequential data read and write
> diff --git a/src/libcamera/v4l2_pixelformat.cpp b/src/libcamera/v4l2_pixelformat.cpp
> index 6b05909f56ae..03ab085c1231 100644
> --- a/src/libcamera/v4l2_pixelformat.cpp
> +++ b/src/libcamera/v4l2_pixelformat.cpp
> @@ -22,6 +22,7 @@
>    * \file v4l2_pixelformat.h
>    * \brief V4L2 Pixel Format
>    */
> +
>   namespace libcamera {
>   
>   LOG_DECLARE_CATEGORY(V4L2)
> diff --git a/src/libcamera/v4l2_videodevice.cpp b/src/libcamera/v4l2_videodevice.cpp
> index 508522ef42bb..16162e1edba3 100644
> --- a/src/libcamera/v4l2_videodevice.cpp
> +++ b/src/libcamera/v4l2_videodevice.cpp
> @@ -32,6 +32,7 @@
>    * \file v4l2_videodevice.h
>    * \brief V4L2 Video Device
>    */
> +
>   namespace libcamera {
>   
>   LOG_DECLARE_CATEGORY(V4L2)
Laurent Pinchart Oct. 20, 2020, 8:57 a.m. UTC | #3 
Hi Umang,

On Tue, Oct 20, 2020 at 09:18:57AM +0530, Umang Jain wrote:
> On 10/20/20 5:33 AM, Laurent Pinchart wrote:
> > Make the whole code base consistent by placing the doxygen \file block
> > above the libcamera namespace opening. There's a single offender, and
> > two locations in which a white line is missing.
> >
> > Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
>
> LGTM. I found src/libcamera/utils.cpp to be a bit-special but seems OK 
> to me. It would help you can double check it too.

I think it's fine too. Thanks for checking.

> Reviewed-by: Umang Jain <email@uajain.com>
>
> > ---
> >   src/libcamera/byte_stream_buffer.cpp | 8 ++++----
> >   src/libcamera/v4l2_pixelformat.cpp   | 1 +
> >   src/libcamera/v4l2_videodevice.cpp   | 1 +
> >   3 files changed, 6 insertions(+), 4 deletions(-)
> >
> > diff --git a/src/libcamera/byte_stream_buffer.cpp b/src/libcamera/byte_stream_buffer.cpp
> > index df7029b02a7f..eb9003927266 100644
> > --- a/src/libcamera/byte_stream_buffer.cpp
> > +++ b/src/libcamera/byte_stream_buffer.cpp
> > @@ -12,15 +12,15 @@
> >   
> >   #include "libcamera/internal/log.h"
> >   
> > -namespace libcamera {
> > -
> > -LOG_DEFINE_CATEGORY(Serialization);
> > -
> >   /**
> >    * \file byte_stream_buffer.h
> >    * \brief Managed memory container for serialized data
> >    */
> >   
> > +namespace libcamera {
> > +
> > +LOG_DEFINE_CATEGORY(Serialization);
> > +
> >   /**
> >    * \class ByteStreamBuffer
> >    * \brief Wrap a memory buffer and provide sequential data read and write
> > diff --git a/src/libcamera/v4l2_pixelformat.cpp b/src/libcamera/v4l2_pixelformat.cpp
> > index 6b05909f56ae..03ab085c1231 100644
> > --- a/src/libcamera/v4l2_pixelformat.cpp
> > +++ b/src/libcamera/v4l2_pixelformat.cpp
> > @@ -22,6 +22,7 @@
> >    * \file v4l2_pixelformat.h
> >    * \brief V4L2 Pixel Format
> >    */
> > +
> >   namespace libcamera {
> >   
> >   LOG_DECLARE_CATEGORY(V4L2)
> > diff --git a/src/libcamera/v4l2_videodevice.cpp b/src/libcamera/v4l2_videodevice.cpp
> > index 508522ef42bb..16162e1edba3 100644
> > --- a/src/libcamera/v4l2_videodevice.cpp
> > +++ b/src/libcamera/v4l2_videodevice.cpp
> > @@ -32,6 +32,7 @@
> >    * \file v4l2_videodevice.h
> >    * \brief V4L2 Video Device
> >    */
> > +
> >   namespace libcamera {
> >   
> >   LOG_DECLARE_CATEGORY(V4L2)
Kieran Bingham Oct. 20, 2020, 10:41 a.m. UTC | #4 
On 20/10/2020 01:03, Laurent Pinchart wrote:
> Make the whole code base consistent by placing the doxygen \file block
> above the libcamera namespace opening. There's a single offender, and
> two locations in which a white line is missing.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>

> ---
>  src/libcamera/byte_stream_buffer.cpp | 8 ++++----
>  src/libcamera/v4l2_pixelformat.cpp   | 1 +
>  src/libcamera/v4l2_videodevice.cpp   | 1 +
>  3 files changed, 6 insertions(+), 4 deletions(-)
> 
> diff --git a/src/libcamera/byte_stream_buffer.cpp b/src/libcamera/byte_stream_buffer.cpp
> index df7029b02a7f..eb9003927266 100644
> --- a/src/libcamera/byte_stream_buffer.cpp
> +++ b/src/libcamera/byte_stream_buffer.cpp
> @@ -12,15 +12,15 @@
>  
>  #include "libcamera/internal/log.h"
>  
> -namespace libcamera {
> -
> -LOG_DEFINE_CATEGORY(Serialization);
> -
>  /**
>   * \file byte_stream_buffer.h
>   * \brief Managed memory container for serialized data
>   */
>  
> +namespace libcamera {
> +
> +LOG_DEFINE_CATEGORY(Serialization);
> +
>  /**
>   * \class ByteStreamBuffer
>   * \brief Wrap a memory buffer and provide sequential data read and write
> diff --git a/src/libcamera/v4l2_pixelformat.cpp b/src/libcamera/v4l2_pixelformat.cpp
> index 6b05909f56ae..03ab085c1231 100644
> --- a/src/libcamera/v4l2_pixelformat.cpp
> +++ b/src/libcamera/v4l2_pixelformat.cpp
> @@ -22,6 +22,7 @@
>   * \file v4l2_pixelformat.h
>   * \brief V4L2 Pixel Format
>   */
> +
>  namespace libcamera {
>  
>  LOG_DECLARE_CATEGORY(V4L2)
> diff --git a/src/libcamera/v4l2_videodevice.cpp b/src/libcamera/v4l2_videodevice.cpp
> index 508522ef42bb..16162e1edba3 100644
> --- a/src/libcamera/v4l2_videodevice.cpp
> +++ b/src/libcamera/v4l2_videodevice.cpp
> @@ -32,6 +32,7 @@
>   * \file v4l2_videodevice.h
>   * \brief V4L2 Video Device
>   */
> +
>  namespace libcamera {
>  
>  LOG_DECLARE_CATEGORY(V4L2)
>

Patch
diff mbox series 

diff --git a/src/libcamera/byte_stream_buffer.cpp b/src/libcamera/byte_stream_buffer.cpp
index df7029b02a7f..eb9003927266 100644
--- a/src/libcamera/byte_stream_buffer.cpp
+++ b/src/libcamera/byte_stream_buffer.cpp
@@ -12,15 +12,15 @@ 
 
 #include "libcamera/internal/log.h"
 
-namespace libcamera {
-
-LOG_DEFINE_CATEGORY(Serialization);
-
 /**
  * \file byte_stream_buffer.h
  * \brief Managed memory container for serialized data
  */
 
+namespace libcamera {
+
+LOG_DEFINE_CATEGORY(Serialization);
+
 /**
  * \class ByteStreamBuffer
  * \brief Wrap a memory buffer and provide sequential data read and write
diff --git a/src/libcamera/v4l2_pixelformat.cpp b/src/libcamera/v4l2_pixelformat.cpp
index 6b05909f56ae..03ab085c1231 100644
--- a/src/libcamera/v4l2_pixelformat.cpp
+++ b/src/libcamera/v4l2_pixelformat.cpp
@@ -22,6 +22,7 @@ 
  * \file v4l2_pixelformat.h
  * \brief V4L2 Pixel Format
  */
+
 namespace libcamera {
 
 LOG_DECLARE_CATEGORY(V4L2)
diff --git a/src/libcamera/v4l2_videodevice.cpp b/src/libcamera/v4l2_videodevice.cpp
index 508522ef42bb..16162e1edba3 100644
--- a/src/libcamera/v4l2_videodevice.cpp
+++ b/src/libcamera/v4l2_videodevice.cpp
@@ -32,6 +32,7 @@ 
  * \file v4l2_videodevice.h
  * \brief V4L2 Video Device
  */
+
 namespace libcamera {
 
 LOG_DECLARE_CATEGORY(V4L2)