[libcamera-devel,2/2] Documentation: Align Doxyfile.in style with doxygen

17260 diff mbox series

Align the style of Doxyfile.in with the `doxygen -g` output, to minimize
diffs in the future when updating the file with `doxygen -u`. This
includes

- Replacing tabs with spaces
- Replacing += with \ to continue lines
- Dropping the \ on the last line of an option

Also update the Doxygen version number to indicate that the file has
been updated to v1.9.5, even if no modification to the options in use
were needed.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 Documentation/Doxyfile.in | 38 +++++++++++++++++++-------------------
 1 file changed, 19 insertions(+), 19 deletions(-)

Quoting Laurent Pinchart via libcamera-devel (2022-08-30 13:19:06)
> Align the style of Doxyfile.in with the `doxygen -g` output, to minimize
> diffs in the future when updating the file with `doxygen -u`. This
> includes
> 
> - Replacing tabs with spaces
> - Replacing += with \ to continue lines
> - Dropping the \ on the last line of an option
> 
> Also update the Doxygen version number to indicate that the file has
> been updated to v1.9.5, even if no modification to the options in use
> were needed.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>


Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>

> ---
>  Documentation/Doxyfile.in | 38 +++++++++++++++++++-------------------
>  1 file changed, 19 insertions(+), 19 deletions(-)
> 
> diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in
> index 0011b82f2353..88dfcddaebf6 100644
> --- a/Documentation/Doxyfile.in
> +++ b/Documentation/Doxyfile.in
> @@ -1,5 +1,5 @@
>  # SPDX-License-Identifier: CC-BY-SA-4.0
> -# Doxyfile 1.8.14
> +# Doxyfile 1.9.5
>  
>  PROJECT_NAME           = "libcamera"
>  PROJECT_NUMBER         = "@VERSION@"
> @@ -9,9 +9,9 @@ OUTPUT_DIRECTORY       = Documentation
>  
>  STRIP_FROM_PATH        = "@TOP_SRCDIR@"
>  
> -ALIASES                = "context=\xrefitem context \"Thread Safety\" \"Thread Safety\""
> -ALIASES               += "threadbound=\ref thread-bound \"thread-bound\""
> -ALIASES               += "threadsafe=\ref thread-safe \"thread-safe\""
> +ALIASES                = "context=\xrefitem context \"Thread Safety\" \"Thread Safety\"" \
> +                         "threadbound=\ref thread-bound \"thread-bound\"" \
> +                         "threadsafe=\ref thread-safe \"thread-safe\""
>  
>  EXTENSION_MAPPING      = h=C++
>  
> @@ -23,10 +23,10 @@ QUIET                  = YES
>  
>  INPUT                  = "@TOP_SRCDIR@/include/libcamera" \
>                           "@TOP_SRCDIR@/src/ipa/ipu3" \
> -                        "@TOP_SRCDIR@/src/ipa/libipa" \
> -                        "@TOP_SRCDIR@/src/libcamera" \
> -                        "@TOP_BUILDDIR@/include/libcamera" \
> -                        "@TOP_BUILDDIR@/src/libcamera"
> +                         "@TOP_SRCDIR@/src/ipa/libipa" \
> +                         "@TOP_SRCDIR@/src/libcamera" \
> +                         "@TOP_BUILDDIR@/include/libcamera" \
> +                         "@TOP_BUILDDIR@/src/libcamera"
>  
>  FILE_PATTERNS          = *.c \
>                           *.cpp \
> @@ -35,23 +35,23 @@ FILE_PATTERNS          = *.c \
>  RECURSIVE              = YES
>  
>  EXCLUDE                = @TOP_SRCDIR@/include/libcamera/base/span.h \
> -                        @TOP_SRCDIR@/include/libcamera/internal/device_enumerator_sysfs.h \
> -                        @TOP_SRCDIR@/include/libcamera/internal/device_enumerator_udev.h \
> -                        @TOP_SRCDIR@/include/libcamera/internal/ipc_pipe_unixsocket.h \
> -                        @TOP_SRCDIR@/src/libcamera/device_enumerator_sysfs.cpp \
> -                        @TOP_SRCDIR@/src/libcamera/device_enumerator_udev.cpp \
> -                        @TOP_SRCDIR@/src/libcamera/ipc_pipe_unixsocket.cpp \
> -                        @TOP_SRCDIR@/src/libcamera/pipeline/ \
> -                        @TOP_SRCDIR@/src/libcamera/tracepoints.cpp \
> -                        @TOP_BUILDDIR@/include/libcamera/internal/tracepoints.h \
> -                        @TOP_BUILDDIR@/src/libcamera/proxy/
> +                         @TOP_SRCDIR@/include/libcamera/internal/device_enumerator_sysfs.h \
> +                         @TOP_SRCDIR@/include/libcamera/internal/device_enumerator_udev.h \
> +                         @TOP_SRCDIR@/include/libcamera/internal/ipc_pipe_unixsocket.h \
> +                         @TOP_SRCDIR@/src/libcamera/device_enumerator_sysfs.cpp \
> +                         @TOP_SRCDIR@/src/libcamera/device_enumerator_udev.cpp \
> +                         @TOP_SRCDIR@/src/libcamera/ipc_pipe_unixsocket.cpp \
> +                         @TOP_SRCDIR@/src/libcamera/pipeline/ \
> +                         @TOP_SRCDIR@/src/libcamera/tracepoints.cpp \
> +                         @TOP_BUILDDIR@/include/libcamera/internal/tracepoints.h \
> +                         @TOP_BUILDDIR@/src/libcamera/proxy/
>  
>  EXCLUDE_PATTERNS       = @TOP_BUILDDIR@/include/libcamera/ipa/*_serializer.h \
>                           @TOP_BUILDDIR@/include/libcamera/ipa/*_proxy.h \
>                           @TOP_BUILDDIR@/include/libcamera/ipa/ipu3_*.h \
>                           @TOP_BUILDDIR@/include/libcamera/ipa/raspberrypi_*.h \
>                           @TOP_BUILDDIR@/include/libcamera/ipa/rkisp1_*.h \
> -                         @TOP_BUILDDIR@/include/libcamera/ipa/vimc_*.h \
> +                         @TOP_BUILDDIR@/include/libcamera/ipa/vimc_*.h
>  
>  EXCLUDE_SYMBOLS        = libcamera::BoundMethodArgs \
>                           libcamera::BoundMethodBase \
> -- 
> Regards,
> 
> Laurent Pinchart
>