[{"id":36484,"web_url":"https://patchwork.libcamera.org/comment/36484/","msgid":"<20251027121346.GH1544@pendragon.ideasonboard.com>","date":"2025-10-27T12:13:46","subject":"Re: [PATCH v1 2/2] config: Fix doxygen 1.15.0 errors","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"On Mon, Oct 27, 2025 at 11:53:33AM +0100, Barnabás Pőcze wrote:\n> Some comments use `text' to quote words, but the unbalanced backticks lead\n> doxygen to complain. Fix those by using `text`, also add `%` in front of\n> the words \"configuration\" and \"version\" to suppress automatic linking\n> of the quoted text to corresponding member functions.\n> \n> Signed-off-by: Barnabás Pőcze \n\nReviewed-by: Laurent Pinchart \n\n> ---\n> src/libcamera/global_configuration.cpp | 12 ++++++------\n> 1 file changed, 6 insertions(+), 6 deletions(-)\n> \n> diff --git a/src/libcamera/global_configuration.cpp b/src/libcamera/global_configuration.cpp\n> index 1d6292ef99..e086246d68 100644\n> --- a/src/libcamera/global_configuration.cpp\n> +++ b/src/libcamera/global_configuration.cpp\n> @@ -37,7 +37,7 @@ LOG_DEFINE_CATEGORY(Configuration)\n> * \\brief Support for global libcamera configuration\n> *\n> * The configuration file is a YAML file and the configuration itself is stored\n> - * under a `configuration' top-level item.\n> + * under a `%configuration` top-level item.\n> *\n> * The configuration file is looked up in the user's home directory first and,\n> * if it is not found, then in system-wide configuration directories. If\n> @@ -132,7 +132,7 @@ GlobalConfiguration::GlobalConfiguration()\n> * \\brief Retrieve the value of configuration option \\a confPath\n> * \\tparam T The type of the retrieved configuration value\n> * \\param[in] confPath Sequence of the YAML section names (excluding\n> - * `configuration') leading to the requested option\n> + * `%configuration`) leading to the requested option\n> * \\return The value of the configuration item corresponding to \\a confPath if\n> * it exists in the configuration file, or no value otherwise\n> */\n> @@ -140,7 +140,7 @@ GlobalConfiguration::GlobalConfiguration()\n> /**\n> * \\brief Retrieve the value of configuration option \\a confPath\n> * \\param[in] confPath Sequence of the YAML section names (excluding\n> - * `configuration') leading to the requested list option, separated by dots\n> + * `%configuration`) leading to the requested list option, separated by dots\n> * \\return A vector of strings or no value if not found\n> */\n> std::optional> GlobalConfiguration::listOption(\n> @@ -219,8 +219,8 @@ std::optional> GlobalConfiguration::envListOption(\n> /**\n> * \\brief Retrieve the configuration version\n> *\n> - * The version is declared in the configuration file in the top-level `version'\n> - * element, alongside `configuration'. This has currently no real use but may be\n> + * The version is declared in the configuration file in the top-level `%version`\n> + * element, alongside `%configuration`. This has currently no real use but may be\n> * needed in future if configuration incompatibilities occur.\n> *\n> * \\return Configuration version as declared in the configuration file or 0 if\n> @@ -235,7 +235,7 @@ unsigned int GlobalConfiguration::version() const\n> * \\brief Retrieve the libcamera global configuration\n> *\n> * This returns the whole configuration stored in the top-level section\n> - * `configuration' of the YAML configuration file.\n> + * `%configuration` of the YAML configuration file.\n> *\n> * The requested part of the configuration can be accessed using \\a YamlObject\n> * methods.","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 B52D0BE080\n\tfor ;\n\tMon, 27 Oct 2025 12:14:01 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 67F8E60766;\n\tMon, 27 Oct 2025 13:14:01 +0100 (CET)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 1DA7F6069A\n\tfor ;\n\tMon, 27 Oct 2025 13:14:00 +0100 (CET)","from pendragon.ideasonboard.com (unknown [193.209.96.36])\n\tby perceval.ideasonboard.com (Postfix) with UTF8SMTPSA id 4F8131661; \n\tMon, 27 Oct 2025 13:12:12 +0100 (CET)"],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"oN+AzHNE\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1761567132;\n\tbh=AzjEUI80GDG6mzEhYY4jnY/Sl2VFUPp04LRgQgjQ1oo=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=oN+AzHNEbWWgefIWdtEpeYldAEXSZ73R1DiHBecb6kllyR3xWQoxp1GPo0komVB8C\n\tkkfhsjzNX57cZhIIeMMw3wlLh3Liu2SF+YkOto0DAeRKjGwZyj523KqlzKb2SRIJKQ\n\tu2oeMvooK1T6eYRiGm2HqCgxinKo5UI8fFvlu7Rg=","Date":"Mon, 27 Oct 2025 14:13:46 +0200","From":"Laurent Pinchart ","To":"=?utf-8?q?Barnab=C3=A1s_P=C5=91cze?= ","Cc":"libcamera-devel@lists.libcamera.org","Subject":"Re: [PATCH v1 2/2] config: Fix doxygen 1.15.0 errors","Message-ID":"<20251027121346.GH1544@pendragon.ideasonboard.com>","References":"<20251027105333.103186-1-barnabas.pocze@ideasonboard.com>\n\t<20251027105333.103186-3-barnabas.pocze@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","Content-Transfer-Encoding":"8bit","In-Reply-To":"<20251027105333.103186-3-barnabas.pocze@ideasonboard.com>","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\" "}},{"id":36496,"web_url":"https://patchwork.libcamera.org/comment/36496/","msgid":"<176158660903.3742839.7111563144029733147@ping.linuxembedded.co.uk>","date":"2025-10-27T17:36:49","subject":"Re: [PATCH v1 2/2] config: Fix doxygen 1.15.0 errors","submitter":{"id":4,"url":"https://patchwork.libcamera.org/api/people/4/","name":"Kieran Bingham","email":"kieran.bingham@ideasonboard.com"},"content":"Quoting Barnabás Pőcze (2025-10-27 10:53:33)\n> Some comments use `text' to quote words, but the unbalanced backticks lead\n> doxygen to complain. Fix those by using `text`, also add `%` in front of\n> the words \"configuration\" and \"version\" to suppress automatic linking\n> of the quoted text to corresponding member functions.\n> \n> Signed-off-by: Barnabás Pőcze \n\nReviewed-by: Kieran Bingham \n\n> ---\n> src/libcamera/global_configuration.cpp | 12 ++++++------\n> 1 file changed, 6 insertions(+), 6 deletions(-)\n> \n> diff --git a/src/libcamera/global_configuration.cpp b/src/libcamera/global_configuration.cpp\n> index 1d6292ef99..e086246d68 100644\n> --- a/src/libcamera/global_configuration.cpp\n> +++ b/src/libcamera/global_configuration.cpp\n> @@ -37,7 +37,7 @@ LOG_DEFINE_CATEGORY(Configuration)\n> * \\brief Support for global libcamera configuration\n> *\n> * The configuration file is a YAML file and the configuration itself is stored\n> - * under a `configuration' top-level item.\n> + * under a `%configuration` top-level item.\n> *\n> * The configuration file is looked up in the user's home directory first and,\n> * if it is not found, then in system-wide configuration directories. If\n> @@ -132,7 +132,7 @@ GlobalConfiguration::GlobalConfiguration()\n> * \\brief Retrieve the value of configuration option \\a confPath\n> * \\tparam T The type of the retrieved configuration value\n> * \\param[in] confPath Sequence of the YAML section names (excluding\n> - * `configuration') leading to the requested option\n> + * `%configuration`) leading to the requested option\n> * \\return The value of the configuration item corresponding to \\a confPath if\n> * it exists in the configuration file, or no value otherwise\n> */\n> @@ -140,7 +140,7 @@ GlobalConfiguration::GlobalConfiguration()\n> /**\n> * \\brief Retrieve the value of configuration option \\a confPath\n> * \\param[in] confPath Sequence of the YAML section names (excluding\n> - * `configuration') leading to the requested list option, separated by dots\n> + * `%configuration`) leading to the requested list option, separated by dots\n> * \\return A vector of strings or no value if not found\n> */\n> std::optional> GlobalConfiguration::listOption(\n> @@ -219,8 +219,8 @@ std::optional> GlobalConfiguration::envListOption(\n> /**\n> * \\brief Retrieve the configuration version\n> *\n> - * The version is declared in the configuration file in the top-level `version'\n> - * element, alongside `configuration'. This has currently no real use but may be\n> + * The version is declared in the configuration file in the top-level `%version`\n> + * element, alongside `%configuration`. This has currently no real use but may be\n> * needed in future if configuration incompatibilities occur.\n> *\n> * \\return Configuration version as declared in the configuration file or 0 if\n> @@ -235,7 +235,7 @@ unsigned int GlobalConfiguration::version() const\n> * \\brief Retrieve the libcamera global configuration\n> *\n> * This returns the whole configuration stored in the top-level section\n> - * `configuration' of the YAML configuration file.\n> + * `%configuration` of the YAML configuration file.\n> *\n> * The requested part of the configuration can be accessed using \\a YamlObject\n> * methods.\n> -- \n> 2.51.1\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 05383BE080\n\tfor ;\n\tMon, 27 Oct 2025 17:36:53 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id C59DC6077C;\n\tMon, 27 Oct 2025 18:36:52 +0100 (CET)","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 7E3986069A\n\tfor ;\n\tMon, 27 Oct 2025 18:36:51 +0100 (CET)","from pendragon.ideasonboard.com\n\t(cpc89244-aztw30-2-0-cust6594.18-1.cable.virginm.net [86.31.185.195])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 9B83AE9B;\n\tMon, 27 Oct 2025 18:35:03 +0100 (CET)"],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"RTDbdbjM\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1761586503;\n\tbh=5OnAyplHeIdtc2AwgcLDFE2K8e/t5lcXVE9koP1t5vs=;\n\th=In-Reply-To:References:Subject:From:To:Date:From;\n\tb=RTDbdbjMlbJRMkVG/NeyJUfai8l7g3lpLUAXcDvcbi2I9vrpnQRqcoHXxVAcSfXi/\n\tyQXwm+vD4RumQuJkuKu3HEs1vhSZxcFuHhkxLg5skuLbGTNxsbn2+i3+pDZqDeaqW5\n\tPMG9Pc/hzqCUwCnKwPhxUsOxf/+T4OvDsdlcJiIg=","Content-Type":"text/plain; charset=\"utf-8\"","MIME-Version":"1.0","Content-Transfer-Encoding":"quoted-printable","In-Reply-To":"<20251027105333.103186-3-barnabas.pocze@ideasonboard.com>","References":"<20251027105333.103186-1-barnabas.pocze@ideasonboard.com>\n\t<20251027105333.103186-3-barnabas.pocze@ideasonboard.com>","Subject":"Re: [PATCH v1 2/2] config: Fix doxygen 1.15.0 errors","From":"Kieran Bingham ","To":"=?utf-8?q?Barnab=C3=A1s_P=C5=91cze?= ,\n\tlibcamera-devel@lists.libcamera.org","Date":"Mon, 27 Oct 2025 17:36:49 +0000","Message-ID":"<176158660903.3742839.7111563144029733147@ping.linuxembedded.co.uk>","User-Agent":"alot/0.9.1","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\" "}}]