Documentation: Use standard ordering for Doxyfile variables
diff mbox series

Message ID 20250908185230.25287-1-laurent.pinchart@ideasonboard.com
State Superseded
Headers show
Series
  • Documentation: Use standard ordering for Doxyfile variables
Related show

Commit Message

Laurent Pinchart Sept. 8, 2025, 6:52 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(-)


base-commit: b8d332cdcc130c27232f61369e7bab2d954e7ac6

Comments

Barnabás Pőcze Sept. 9, 2025, 7:50 a.m. UTC | #1 
Hi

2025. 09. 08. 20:52 keltezéssel, Laurent Pinchart írta:
> 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.

Was this change generated "manually"? Or does doxygen have a feature to format
a doxyfile like this?


Regards,
Barnabás Pőcze


> 
> 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(-)
> 
> 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
> 
> base-commit: b8d332cdcc130c27232f61369e7bab2d954e7ac6
Laurent Pinchart Sept. 9, 2025, 5:35 p.m. UTC | #2 
On Tue, Sep 09, 2025 at 09:50:44AM +0200, Barnabás Pőcze wrote:
> 2025. 09. 08. 20:52 keltezéssel, Laurent Pinchart írta:
> > 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.
> 
> Was this change generated "manually"? Or does doxygen have a feature to format
> a doxyfile like this?

Semi-manually :-) I ran

doxygen -g /dev/stdout | grep "^\($(cat Documentation/Doxyfile-common.in | grep '^[A-Z]' | sed 's/ .*//' | awk 'ORS="\\|"' | head -c -2)\)" | sed 's/ .*//'

which prints the order in which the fields should be ordered. I'm sure
this could be further scripted to reorder a file.

> > 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(-)
> > 
> > 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
> > 
> > base-commit: b8d332cdcc130c27232f61369e7bab2d954e7ac6

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