{"id":24835,"url":"https://patchwork.libcamera.org/api/1.1/patches/24835/?format=json","web_url":"https://patchwork.libcamera.org/patch/24835/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/1.1/projects/1/?format=json","name":"libcamera","link_name":"libcamera","list_id":"libcamera_core","list_email":"libcamera-devel@lists.libcamera.org","web_url":"","scm_url":"","webscm_url":""},"msgid":"<20251027105333.103186-3-barnabas.pocze@ideasonboard.com>","date":"2025-10-27T10:53:33","name":"[v1,2/2] config: Fix doxygen 1.15.0 errors","commit_ref":null,"pull_url":null,"state":"accepted","archived":false,"hash":"7a80ab21ee87e2f659090fbdaa8f6b60a0997da9","submitter":{"id":216,"url":"https://patchwork.libcamera.org/api/1.1/people/216/?format=json","name":"Barnabás Pőcze","email":"barnabas.pocze@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/24835/mbox/","series":[{"id":5533,"url":"https://patchwork.libcamera.org/api/1.1/series/5533/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=5533","date":"2025-10-27T10:53:31","name":"Fix doxygen 1.15.0 issues","version":1,"mbox":"https://patchwork.libcamera.org/series/5533/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/24835/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/24835/checks/","tags":{},"headers":{"Return-Path":"<libcamera-devel-bounces@lists.libcamera.org>","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 2D8F7BE080\n\tfor <parsemail@patchwork.libcamera.org>;\n\tMon, 27 Oct 2025 10:53:42 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 4D7D36075A;\n\tMon, 27 Oct 2025 11:53:41 +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 B32D360708\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tMon, 27 Oct 2025 11:53:36 +0100 (CET)","from pb-laptop.local (185.182.215.162.nat.pool.zt.hu\n\t[185.182.215.162])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 0A1101783\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tMon, 27 Oct 2025 11:51:49 +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=\"toha45Tc\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1761562309;\n\tbh=3KRYIo7gFC01o0DkRxveVeZNguym63a4rYyZK8CncAk=;\n\th=From:To:Subject:Date:In-Reply-To:References:From;\n\tb=toha45TcgIb2hJCVVabnf75Tl9pUswtv+VHeuVlLgB9v44t9a2dmxxM9JTuZ4hcSs\n\tD6OOD02mmFKP26KRjR3ATFDvH21UX5f/3srq3cKB/9HiK58jGHfl/cAETCsJJbd3Bw\n\tnsJbvhrt/CW01XBHxQdIshyAscfjEeRJRqPF2mkY=","From":"=?utf-8?q?Barnab=C3=A1s_P=C5=91cze?= <barnabas.pocze@ideasonboard.com>","To":"libcamera-devel@lists.libcamera.org","Subject":"[PATCH v1 2/2] config: Fix doxygen 1.15.0 errors","Date":"Mon, 27 Oct 2025 11:53:33 +0100","Message-ID":"<20251027105333.103186-3-barnabas.pocze@ideasonboard.com>","X-Mailer":"git-send-email 2.51.1","In-Reply-To":"<20251027105333.103186-1-barnabas.pocze@ideasonboard.com>","References":"<20251027105333.103186-1-barnabas.pocze@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=UTF-8","Content-Transfer-Encoding":"8bit","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"<libcamera-devel.lists.libcamera.org>","List-Unsubscribe":"<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>","List-Archive":"<https://lists.libcamera.org/pipermail/libcamera-devel/>","List-Post":"<mailto:libcamera-devel@lists.libcamera.org>","List-Help":"<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>","List-Subscribe":"<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>"},"content":"Some comments use `text' to quote words, but the unbalanced backticks lead\ndoxygen to complain. Fix those by using `text`, also add `%` in front of\nthe words \"configuration\" and \"version\" to suppress automatic linking\nof the quoted text to corresponding member functions.\n\nSigned-off-by: Barnabás Pőcze <barnabas.pocze@ideasonboard.com>\n---\n src/libcamera/global_configuration.cpp | 12 ++++++------\n 1 file changed, 6 insertions(+), 6 deletions(-)","diff":"diff --git a/src/libcamera/global_configuration.cpp b/src/libcamera/global_configuration.cpp\nindex 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<std::vector<std::string>> GlobalConfiguration::listOption(\n@@ -219,8 +219,8 @@ std::optional<std::vector<std::string>> 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","prefixes":["v1","2/2"]}