Documentation: Enable treeview generation for doxygen < 1.13.0
diff mbox series

Message ID 20260416143256.2664804-1-stefan.klug@ideasonboard.com
State New
Headers show
Series
  • Documentation: Enable treeview generation for doxygen < 1.13.0
Related show

Commit Message

Stefan Klug April 16, 2026, 2:32 p.m. UTC
Between v1 and the now merged v2 of commit 42d914f20cb0 ("Documentation:
Enable doxygen-awesome-css") the GENERATE_TREEVIEW = YES was dropped
because it defaults to YES according to the doxygen web documentation.
Unfortunately for doxygen < 1.13.0 the default was NO.  Fix the value to
YES so that doxygen-awesome-css works properly even with older versions
of doxygen.

Fixes: 42d914f20cb0 ("Documentation: Enable doxygen-awesome-css")
Signed-off-by: Stefan Klug <stefan.klug@ideasonboard.com>
---
 Documentation/Doxyfile-common.in | 3 +++
 1 file changed, 3 insertions(+)

Comments

Barnabás Pőcze April 16, 2026, 2:57 p.m. UTC | #1
2026. 04. 16. 16:32 keltezéssel, Stefan Klug írta:
> Between v1 and the now merged v2 of commit 42d914f20cb0 ("Documentation:

Isn't it v3? https://patchwork.libcamera.org/patch/24381/


> Enable doxygen-awesome-css") the GENERATE_TREEVIEW = YES was dropped
> because it defaults to YES according to the doxygen web documentation.
> Unfortunately for doxygen < 1.13.0 the default was NO.  Fix the value to
> YES so that doxygen-awesome-css works properly even with older versions
> of doxygen.
> 
> Fixes: 42d914f20cb0 ("Documentation: Enable doxygen-awesome-css")
> Signed-off-by: Stefan Klug <stefan.klug@ideasonboard.com>
> ---

Tested-by: Barnabás Pőcze <barnabas.pocze@ideasonboard.com> # doxygen 1.16.1
Reviewed-by: Barnabás Pőcze <barnabas.pocze@ideasonboard.com>


>   Documentation/Doxyfile-common.in | 3 +++
>   1 file changed, 3 insertions(+)
> 
> diff --git a/Documentation/Doxyfile-common.in b/Documentation/Doxyfile-common.in
> index 23a0e3626f9d..f11ec593d5ae 100644
> --- a/Documentation/Doxyfile-common.in
> +++ b/Documentation/Doxyfile-common.in
> @@ -57,6 +57,9 @@ IMAGE_PATH             = "@TOP_SRCDIR@/Documentation/images"
>   HTML_EXTRA_STYLESHEET  = "@TOP_SRCDIR@/Documentation/doxygen-awesome-css/doxygen-awesome.css" \
>                            "@TOP_SRCDIR@/Documentation/doxygen-awesome-css/doxygen-awesome-sidebar-only.css"
>   
> +# The default value changed to YES in doxygen 1.13.0
> +GENERATE_TREEVIEW      = YES
> +
>   GENERATE_LATEX         = NO
>   
>   MACRO_EXPANSION        = YES
Laurent Pinchart April 16, 2026, 5:43 p.m. UTC | #2
On Thu, Apr 16, 2026 at 04:32:48PM +0200, Stefan Klug wrote:
> Between v1 and the now merged v2 of commit 42d914f20cb0 ("Documentation:
> Enable doxygen-awesome-css") the GENERATE_TREEVIEW = YES was dropped
> because it defaults to YES according to the doxygen web documentation.
> Unfortunately for doxygen < 1.13.0 the default was NO.  Fix the value to
> YES so that doxygen-awesome-css works properly even with older versions
> of doxygen.
> 
> Fixes: 42d914f20cb0 ("Documentation: Enable doxygen-awesome-css")
> Signed-off-by: Stefan Klug <stefan.klug@ideasonboard.com>

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

> ---
>  Documentation/Doxyfile-common.in | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/Documentation/Doxyfile-common.in b/Documentation/Doxyfile-common.in
> index 23a0e3626f9d..f11ec593d5ae 100644
> --- a/Documentation/Doxyfile-common.in
> +++ b/Documentation/Doxyfile-common.in
> @@ -57,6 +57,9 @@ IMAGE_PATH             = "@TOP_SRCDIR@/Documentation/images"
>  HTML_EXTRA_STYLESHEET  = "@TOP_SRCDIR@/Documentation/doxygen-awesome-css/doxygen-awesome.css" \
>                           "@TOP_SRCDIR@/Documentation/doxygen-awesome-css/doxygen-awesome-sidebar-only.css"
>  
> +# The default value changed to YES in doxygen 1.13.0
> +GENERATE_TREEVIEW      = YES
> +
>  GENERATE_LATEX         = NO
>  
>  MACRO_EXPANSION        = YES

Patch
diff mbox series

diff --git a/Documentation/Doxyfile-common.in b/Documentation/Doxyfile-common.in
index 23a0e3626f9d..f11ec593d5ae 100644
--- a/Documentation/Doxyfile-common.in
+++ b/Documentation/Doxyfile-common.in
@@ -57,6 +57,9 @@  IMAGE_PATH             = "@TOP_SRCDIR@/Documentation/images"
 HTML_EXTRA_STYLESHEET  = "@TOP_SRCDIR@/Documentation/doxygen-awesome-css/doxygen-awesome.css" \
                          "@TOP_SRCDIR@/Documentation/doxygen-awesome-css/doxygen-awesome-sidebar-only.css"
 
+# The default value changed to YES in doxygen 1.13.0
+GENERATE_TREEVIEW      = YES
+
 GENERATE_LATEX         = NO
 
 MACRO_EXPANSION        = YES