[v2,01/10] Documentation: Use standard ordering for Doxyfile variables
diff mbox series

Message ID 20250911230115.25335-2-laurent.pinchart@ideasonboard.com
State New
Headers show
Series
  • Documentation theming update
Related show

Commit Message

Laurent Pinchart Sept. 11, 2025, 11:01 p.m. UTC 
Order the variables in Doxyfiles as in the template generated by
'doxygen -g'. This doesn't have any functional change, but provides a
standard order when adding new variables.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 Documentation/Doxyfile-common.in   | 6 +++---
 Documentation/Doxyfile-internal.in | 9 +++++----
 Documentation/Doxyfile-public.in   | 9 +++++----
 3 files changed, 13 insertions(+), 11 deletions(-)

Patch
diff mbox series 

diff --git a/Documentation/Doxyfile-common.in b/Documentation/Doxyfile-common.in
index 58afea1cd70d..c9527da03ed5 100644
--- a/Documentation/Doxyfile-common.in
+++ b/Documentation/Doxyfile-common.in
@@ -29,6 +29,8 @@  FILE_PATTERNS          = *.c \
 
 RECURSIVE              = YES
 
+EXCLUDE_SYMLINKS       = YES
+
 EXCLUDE_PATTERNS       = @TOP_BUILDDIR@/include/libcamera/ipa/*_serializer.h \
                          @TOP_BUILDDIR@/include/libcamera/ipa/*_proxy.h \
                          @TOP_BUILDDIR@/include/libcamera/ipa/ipu3_*.h \
@@ -50,7 +52,7 @@  EXCLUDE_SYMBOLS        = libcamera::BoundMethodArgs \
                          *::details \
                          std::*
 
-EXCLUDE_SYMLINKS       = YES
+IMAGE_PATH             = "@TOP_SRCDIR@/Documentation/images"
 
 GENERATE_LATEX         = NO
 
@@ -61,8 +63,6 @@  INCLUDE_PATH           = "@TOP_BUILDDIR@/include" \
                          "@TOP_SRCDIR@/include"
 INCLUDE_FILE_PATTERNS  = *.h
 
-IMAGE_PATH             = "@TOP_SRCDIR@/Documentation/images"
-
 PREDEFINED             = __DOXYGEN__ \
                          __cplusplus \
                          __attribute__(x)= \
diff --git a/Documentation/Doxyfile-internal.in b/Documentation/Doxyfile-internal.in
index a422bb0719da..aeaa06e9d9d3 100644
--- a/Documentation/Doxyfile-internal.in
+++ b/Documentation/Doxyfile-internal.in
@@ -3,11 +3,8 @@ 
 @INCLUDE_PATH          = @TOP_BUILDDIR@/Documentation
 @INCLUDE               = Doxyfile-common
 
-GENERATE_TAGFILE       = @TOP_BUILDDIR@/Documentation/internal-api-html/tagfile.xml
-
-HIDE_UNDOC_CLASSES     = NO
 HIDE_UNDOC_MEMBERS     = NO
-HTML_OUTPUT            = internal-api-html
+HIDE_UNDOC_CLASSES     = NO
 INTERNAL_DOCS          = YES
 ENABLED_SECTIONS       = internal
 
@@ -33,3 +30,7 @@  EXCLUDE                = @TOP_SRCDIR@/include/libcamera/base/span.h \
                          @TOP_BUILDDIR@/include/libcamera/internal/tracepoints.h \
                          @TOP_BUILDDIR@/include/libcamera/ipa/soft_ipa_interface.h \
                          @TOP_BUILDDIR@/src/libcamera/proxy/
+
+HTML_OUTPUT            = internal-api-html
+
+GENERATE_TAGFILE       = @TOP_BUILDDIR@/Documentation/internal-api-html/tagfile.xml
diff --git a/Documentation/Doxyfile-public.in b/Documentation/Doxyfile-public.in
index c3a8b0dd003a..917f24008579 100644
--- a/Documentation/Doxyfile-public.in
+++ b/Documentation/Doxyfile-public.in
@@ -3,11 +3,8 @@ 
 @INCLUDE_PATH          = @TOP_BUILDDIR@/Documentation
 @INCLUDE               = Doxyfile-common
 
-GENERATE_TAGFILE       = @TOP_BUILDDIR@/Documentation/api-html/tagfile.xml
-
-HIDE_UNDOC_CLASSES     = YES
 HIDE_UNDOC_MEMBERS     = YES
-HTML_OUTPUT            = api-html
+HIDE_UNDOC_CLASSES     = YES
 INTERNAL_DOCS          = NO
 
 INPUT                  = "@TOP_SRCDIR@/Documentation" \
@@ -19,4 +16,8 @@  EXCLUDE                = @TOP_SRCDIR@/include/libcamera/base/class.h \
                          @TOP_SRCDIR@/src/libcamera/base/class.cpp \
                          @TOP_SRCDIR@/src/libcamera/base/object.cpp
 
+HTML_OUTPUT            = api-html
+
 PREDEFINED            += __DOXYGEN_PUBLIC__
+
+GENERATE_TAGFILE       = @TOP_BUILDDIR@/Documentation/api-html/tagfile.xml