[{"id":35862,"web_url":"https://patchwork.libcamera.org/comment/35862/","msgid":"<175817842604.17312.13754027483304769607@localhost>","date":"2025-09-18T06:53:46","subject":"Re: [PATCH v3 01/10] Documentation: Use standard ordering for\n\tDoxyfile variables","submitter":{"id":184,"url":"https://patchwork.libcamera.org/api/people/184/","name":"Stefan Klug","email":"stefan.klug@ideasonboard.com"},"content":"Hi Laurent,\n\nThank you for the patch.\n\nQuoting Laurent Pinchart (2025-09-17 22:17:32)\n> Order the variables in Doxyfiles as in the template generated by\n> 'doxygen -g'. This doesn't have any functional change, but provides a\n> standard order when adding new variables.\n> \n> Signed-off-by: Laurent Pinchart \n> Reviewed-by: Barnabás Pőcze \n> ---\n> Documentation/Doxyfile-common.in | 6 +++---\n> Documentation/Doxyfile-internal.in | 9 +++++----\n> Documentation/Doxyfile-public.in | 9 +++++----\n> 3 files changed, 13 insertions(+), 11 deletions(-)\n> \n> diff --git a/Documentation/Doxyfile-common.in b/Documentation/Doxyfile-common.in\n> index 58afea1cd70d..c9527da03ed5 100644\n> --- a/Documentation/Doxyfile-common.in\n> +++ b/Documentation/Doxyfile-common.in\n> @@ -29,6 +29,8 @@ FILE_PATTERNS = *.c \\\n> \n> RECURSIVE = YES\n> \n> +EXCLUDE_SYMLINKS = YES\n> +\n> EXCLUDE_PATTERNS = @TOP_BUILDDIR@/include/libcamera/ipa/*_serializer.h \\\n> @TOP_BUILDDIR@/include/libcamera/ipa/*_proxy.h \\\n> @TOP_BUILDDIR@/include/libcamera/ipa/ipu3_*.h \\\n> @@ -50,7 +52,7 @@ EXCLUDE_SYMBOLS = libcamera::BoundMethodArgs \\\n> *::details \\\n> std::*\n> \n> -EXCLUDE_SYMLINKS = YES\n> +IMAGE_PATH = \"@TOP_SRCDIR@/Documentation/images\"\n\nWe are a bit inconsistent here. Sometimes we quote and sometimes we\ndon't. I like the unquoted better and I can't imagine anyone building in\na directory with a space but I guess quoting would be correct.\n\nBut not really related to this patch, so\nReviewed-by: Stefan Klug \n\nBest regards,\nStefan\n\n> \n> GENERATE_LATEX = NO\n> \n> @@ -61,8 +63,6 @@ INCLUDE_PATH = \"@TOP_BUILDDIR@/include\" \\\n> \"@TOP_SRCDIR@/include\"\n> INCLUDE_FILE_PATTERNS = *.h\n> \n> -IMAGE_PATH = \"@TOP_SRCDIR@/Documentation/images\"\n> -\n> PREDEFINED = __DOXYGEN__ \\\n> __cplusplus \\\n> __attribute__(x)= \\\n> diff --git a/Documentation/Doxyfile-internal.in b/Documentation/Doxyfile-internal.in\n> index a422bb0719da..aeaa06e9d9d3 100644\n> --- a/Documentation/Doxyfile-internal.in\n> +++ b/Documentation/Doxyfile-internal.in\n> @@ -3,11 +3,8 @@\n> @INCLUDE_PATH = @TOP_BUILDDIR@/Documentation\n> @INCLUDE = Doxyfile-common\n> \n> -GENERATE_TAGFILE = @TOP_BUILDDIR@/Documentation/internal-api-html/tagfile.xml\n> -\n> -HIDE_UNDOC_CLASSES = NO\n> HIDE_UNDOC_MEMBERS = NO\n> -HTML_OUTPUT = internal-api-html\n> +HIDE_UNDOC_CLASSES = NO\n> INTERNAL_DOCS = YES\n> ENABLED_SECTIONS = internal\n> \n> @@ -33,3 +30,7 @@ EXCLUDE = @TOP_SRCDIR@/include/libcamera/base/span.h \\\n> @TOP_BUILDDIR@/include/libcamera/internal/tracepoints.h \\\n> @TOP_BUILDDIR@/include/libcamera/ipa/soft_ipa_interface.h \\\n> @TOP_BUILDDIR@/src/libcamera/proxy/\n> +\n> +HTML_OUTPUT = internal-api-html\n> +\n> +GENERATE_TAGFILE = @TOP_BUILDDIR@/Documentation/internal-api-html/tagfile.xml\n> diff --git a/Documentation/Doxyfile-public.in b/Documentation/Doxyfile-public.in\n> index c3a8b0dd003a..917f24008579 100644\n> --- a/Documentation/Doxyfile-public.in\n> +++ b/Documentation/Doxyfile-public.in\n> @@ -3,11 +3,8 @@\n> @INCLUDE_PATH = @TOP_BUILDDIR@/Documentation\n> @INCLUDE = Doxyfile-common\n> \n> -GENERATE_TAGFILE = @TOP_BUILDDIR@/Documentation/api-html/tagfile.xml\n> -\n> -HIDE_UNDOC_CLASSES = YES\n> HIDE_UNDOC_MEMBERS = YES\n> -HTML_OUTPUT = api-html\n> +HIDE_UNDOC_CLASSES = YES\n> INTERNAL_DOCS = NO\n> \n> INPUT = \"@TOP_SRCDIR@/Documentation\" \\\n> @@ -19,4 +16,8 @@ EXCLUDE = @TOP_SRCDIR@/include/libcamera/base/class.h \\\n> @TOP_SRCDIR@/src/libcamera/base/class.cpp \\\n> @TOP_SRCDIR@/src/libcamera/base/object.cpp\n> \n> +HTML_OUTPUT = api-html\n> +\n> PREDEFINED += __DOXYGEN_PUBLIC__\n> +\n> +GENERATE_TAGFILE = @TOP_BUILDDIR@/Documentation/api-html/tagfile.xml\n> -- \n> Regards,\n> \n> Laurent Pinchart\n>","headers":{"Return-Path":"","X-Original-To":"parsemail@patchwork.libcamera.org","Delivered-To":"parsemail@patchwork.libcamera.org","Received":["from lancelot.ideasonboard.com (lancelot.ideasonboard.com\n\t[92.243.16.209])\n\tby patchwork.libcamera.org (Postfix) with ESMTPS id 10089BE173\n\tfor ;\n\tThu, 18 Sep 2025 06:54:18 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id C16006936F;\n\tThu, 18 Sep 2025 08:54:16 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 10BB262C38\n\tfor ;\n\tThu, 18 Sep 2025 08:53:48 +0200 (CEST)","from ideasonboard.com (unknown\n\t[IPv6:2a00:6020:448c:6c00:ace3:d2c2:5eff:9cc5])\n\tby perceval.ideasonboard.com (Postfix) with UTF8SMTPSA id 39E7119C4; \n\tThu, 18 Sep 2025 08:52:29 +0200 (CEST)"],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"OgmLI1El\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1758178349;\n\tbh=QNzALeKbE/ApF9TX8wzQtkgjTWdIePNeRD1X15ww+yA=;\n\th=In-Reply-To:References:Subject:From:To:Date:From;\n\tb=OgmLI1El3+3/C0XnuFVDTXkVZnSWpqf3RakU+e4KCRTmLqx+CweHSsh2HTXmyIRES\n\tVViiAkSXtu4tom/daSc4y/JJM/AMqy2Qr73/MjslcS9A9vmG8QgPU8E61p/rS/xnaN\n\tsvBi2S6cM3GzvCAxwx2xC0Ed6tGXJDCSuo0WWCGQ=","Content-Type":"text/plain; charset=\"utf-8\"","MIME-Version":"1.0","Content-Transfer-Encoding":"quoted-printable","In-Reply-To":"<20250917201742.16406-2-laurent.pinchart@ideasonboard.com>","References":"<20250917201742.16406-1-laurent.pinchart@ideasonboard.com>\n\t<20250917201742.16406-2-laurent.pinchart@ideasonboard.com>","Subject":"Re: [PATCH v3 01/10] Documentation: Use standard ordering for\n\tDoxyfile variables","From":"Stefan Klug ","To":"Laurent Pinchart ,\n\tlibcamera-devel@lists.libcamera.org","Date":"Thu, 18 Sep 2025 08:53:46 +0200","Message-ID":"<175817842604.17312.13754027483304769607@localhost>","User-Agent":"alot/0.12.dev8+g2c003385c862.d20250602","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}}]