[PATCH v5 01/18] libcamera: Drop path prefix from Doxygen file directive

Laurent Pinchart laurent.pinchart at ideasonboard.com
Mon Aug 5 16:36:37 CEST 2024


The Doxygen directive only requires qualifying header file names with a
path to differentiate between multiple header files with the same name.
Most file directives that refer to unambiguous files do not have a
libcamera/ and/or internal/ path prefix, but a few do, most likely due
to copy&paste. Drop the prefix in those few files for consistency.

Signed-off-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>
---
 src/libcamera/converter.cpp                    | 2 +-
 src/libcamera/converter/converter_v4l2_m2m.cpp | 2 +-
 src/libcamera/fence.cpp                        | 2 +-
 src/libcamera/mapped_framebuffer.cpp           | 2 +-
 src/libcamera/orientation.cpp                  | 2 +-
 src/libcamera/yaml_parser.cpp                  | 2 +-
 6 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/src/libcamera/converter.cpp b/src/libcamera/converter.cpp
index 2ab461332677..8237998f044b 100644
--- a/src/libcamera/converter.cpp
+++ b/src/libcamera/converter.cpp
@@ -14,7 +14,7 @@
 #include "libcamera/internal/media_device.h"
 
 /**
- * \file internal/converter.h
+ * \file converter.h
  * \brief Abstract converter
  */
 
diff --git a/src/libcamera/converter/converter_v4l2_m2m.cpp b/src/libcamera/converter/converter_v4l2_m2m.cpp
index 2e77872e1710..006ba9f7f665 100644
--- a/src/libcamera/converter/converter_v4l2_m2m.cpp
+++ b/src/libcamera/converter/converter_v4l2_m2m.cpp
@@ -23,7 +23,7 @@
 #include "libcamera/internal/v4l2_videodevice.h"
 
 /**
- * \file internal/converter/converter_v4l2_m2m.h
+ * \file converter/converter_v4l2_m2m.h
  * \brief V4L2 M2M based converter
  */
 
diff --git a/src/libcamera/fence.cpp b/src/libcamera/fence.cpp
index 634c74f8e13e..73299b402702 100644
--- a/src/libcamera/fence.cpp
+++ b/src/libcamera/fence.cpp
@@ -11,7 +11,7 @@ namespace libcamera {
 
 /**
  *
- * \file libcamera/fence.h
+ * \file fence.h
  * \brief Definition of the Fence class
  */
 
diff --git a/src/libcamera/mapped_framebuffer.cpp b/src/libcamera/mapped_framebuffer.cpp
index b3104e0504d4..ad82e1f6e49c 100644
--- a/src/libcamera/mapped_framebuffer.cpp
+++ b/src/libcamera/mapped_framebuffer.cpp
@@ -16,7 +16,7 @@
 #include <libcamera/base/log.h>
 
 /**
- * \file libcamera/internal/mapped_framebuffer.h
+ * \file mapped_framebuffer.h
  * \brief Frame buffer memory mapping support
  */
 
diff --git a/src/libcamera/orientation.cpp b/src/libcamera/orientation.cpp
index 47fd6a32502b..fd191197fb8c 100644
--- a/src/libcamera/orientation.cpp
+++ b/src/libcamera/orientation.cpp
@@ -11,7 +11,7 @@
 #include <string>
 
 /**
- * \file libcamera/orientation.h
+ * \file orientation.h
  * \brief Image orientation definition
  */
 
diff --git a/src/libcamera/yaml_parser.cpp b/src/libcamera/yaml_parser.cpp
index 025006bcdcdd..8b6a403898be 100644
--- a/src/libcamera/yaml_parser.cpp
+++ b/src/libcamera/yaml_parser.cpp
@@ -18,7 +18,7 @@
 #include <yaml.h>
 
 /**
- * \file libcamera/internal/yaml_parser.h
+ * \file yaml_parser.h
  * \brief A YAML parser helper
  */
 
-- 
Regards,

Laurent Pinchart



More information about the libcamera-devel mailing list