[PATCH v5 03/18] libcamera: Unify Doxygen file directive prefix for formats.h

[Laurent Pinchart]

On Wed, Aug 07, 2024 at 06:05:20AM +0100, Kieran Bingham wrote:
> Quoting Laurent Pinchart (2024-08-05 15:36:39)
> > libcamera has two formats.h headers, an internal one in
> > include/libcamera/internal/, and a public one generated at build time.
> > The convention is to prefix the internal header name with
> > libcamera/internal/ in the Doxygen file directive, but formats.cpp only
> > uses internal/ as a prefix. Unify it with the rest of the code base.
> 
> kbingham at Monstersaurus:~/iob/libcamera/libcamera-clean$ gg "\\\\file " | grep internal
> src/libcamera/camera_manager.cpp: * \file libcamera/internal/camera_manager.h
> src/libcamera/converter.cpp: * \file internal/converter.h
> src/libcamera/converter/converter_v4l2_m2m.cpp: * \file internal/converter/converter_v4l2_m2m.h
> src/libcamera/formats.cpp: * \file internal/formats.h
> src/libcamera/framebuffer.cpp: * \file libcamera/internal/framebuffer.h
> src/libcamera/mapped_framebuffer.cpp: * \file libcamera/internal/mapped_framebuffer.h
> src/libcamera/yaml_parser.cpp: * \file libcamera/internal/yaml_parser.h
> 
> What about converter.cpp, and converter_v4l2_m2m.cpp ? Or do you prefer
> not to change those if they don't have public headers?

That was the idea, only specifying the full prefix for files that have
both internal and external headers.

> Either with those two also updated in here or handled separately:
> 
> Reviewed-by: Kieran Bingham <kieran.bingham at ideasonboard.com>
> 
> > Signed-off-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>
> > ---
> >  src/libcamera/formats.cpp | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > diff --git a/src/libcamera/formats.cpp b/src/libcamera/formats.cpp
> > index cf41f2c261ed..72fade7cd41c 100644
> > --- a/src/libcamera/formats.cpp
> > +++ b/src/libcamera/formats.cpp
> > @@ -16,7 +16,7 @@
> >  #include <libcamera/formats.h>
> >  
> >  /**
> > - * \file internal/formats.h
> > + * \file libcamera/internal/formats.h
> >   * \brief Types and helper functions to handle libcamera image formats
> >   */
> >  

-- 
Regards,

Laurent Pinchart