[{"id":35791,"web_url":"https://patchwork.libcamera.org/comment/35791/","msgid":"<8205df1b-7255-452f-920b-95dc83e6c61f@ideasonboard.com>","date":"2025-09-12T08:50:40","subject":"Re: [PATCH v2 01/10] Documentation: Use standard ordering for\n\tDoxyfile variables","submitter":{"id":216,"url":"https://patchwork.libcamera.org/api/people/216/","name":"Barnabás Pőcze","email":"barnabas.pocze@ideasonboard.com"},"content":"Hi\n\n2025. 09. 12. 1:01 keltezéssel, Laurent Pinchart írta:\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\nA bit unfortunate that there is no formatting tool that could be even added to checkstyle.py,\nso it seems somewhat inevitable that it will go out of sync sooner or later.\n\nReviewed-by: Barnabás Pőcze \n\n\n> \n> Signed-off-by: Laurent Pinchart \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> \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","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 D9CECBDB13\n\tfor ;\n\tFri, 12 Sep 2025 08:50:47 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 12E1D69367;\n\tFri, 12 Sep 2025 10:50:47 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id CE057613A3\n\tfor ;\n\tFri, 12 Sep 2025 10:50:44 +0200 (CEST)","from [192.168.33.2] (185.221.142.115.nat.pool.zt.hu\n\t[185.221.142.115])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id A1FD46DF;\n\tFri, 12 Sep 2025 10:49: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=\"PnJO1xhm\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1757666969;\n\tbh=/D+SPNcXmeHxe8ZaYcU0mJq8dZeomof1Tv0zy2vp4Gw=;\n\th=Date:Subject:To:References:From:In-Reply-To:From;\n\tb=PnJO1xhmQbw5Xu9DXh/sh5lzIsOVZVfMtX6QA48gIR1kX/vd1xjHk6Bu3pYzjoXOQ\n\trvdfweGILD0pW5sI9ZJLREPuF+rpWHP/arqpoStvsnQbuo+h6vo/2j+Wfk3Bjk+u4v\n\t0eAXIUel3/APxznh1xFvEjzvm1SNEhIL2sifMFZQ=","Message-ID":"<8205df1b-7255-452f-920b-95dc83e6c61f@ideasonboard.com>","Date":"Fri, 12 Sep 2025 10:50:40 +0200","MIME-Version":"1.0","User-Agent":"Mozilla Thunderbird","Subject":"Re: [PATCH v2 01/10] Documentation: Use standard ordering for\n\tDoxyfile variables","To":"Laurent Pinchart ,\n\tlibcamera-devel@lists.libcamera.org","References":"<20250911230115.25335-1-laurent.pinchart@ideasonboard.com>\n\t<20250911230115.25335-2-laurent.pinchart@ideasonboard.com>","From":"=?utf-8?q?Barnab=C3=A1s_P=C5=91cze?= ","Content-Language":"en-US, hu-HU","In-Reply-To":"<20250911230115.25335-2-laurent.pinchart@ideasonboard.com>","Content-Type":"text/plain; charset=UTF-8; format=flowed","Content-Transfer-Encoding":"8bit","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\" "}}]