{"id":26532,"url":"https://patchwork.libcamera.org/api/patches/26532/?format=json","web_url":"https://patchwork.libcamera.org/patch/26532/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/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":"<20260423230059.3180987-11-laurent.pinchart@ideasonboard.com>","date":"2026-04-23T23:00:32","name":"[v3,10/37] libcamera: yaml_parser: Drop unneeded \\fn Doxygen commands","commit_ref":null,"pull_url":null,"state":"accepted","archived":false,"hash":"b4bddde55331e564bc3f8dff2c9af55ba9737113","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/?format=json","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/26532/mbox/","series":[{"id":5883,"url":"https://patchwork.libcamera.org/api/series/5883/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=5883","date":"2026-04-23T23:00:22","name":"libcamera: Global configuration file improvements","version":3,"mbox":"https://patchwork.libcamera.org/series/5883/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/26532/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/26532/checks/","tags":{},"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 08325BDCB5\n\tfor ;\n\tThu, 23 Apr 2026 23:01:22 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 97C4162FA2;\n\tFri, 24 Apr 2026 01:01:21 +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 CD35362F85\n\tfor ;\n\tFri, 24 Apr 2026 01:01:14 +0200 (CEST)","from killaraus.ideasonboard.com\n\t(2001-14ba-703d-e500--2a1.rev.dnainternet.fi\n\t[IPv6:2001:14ba:703d:e500::2a1])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 3AB9C9A6\n\tfor ;\n\tFri, 24 Apr 2026 00:59:35 +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=\"QUUfL50n\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1776985175;\n\tbh=3Q12LBa5A4kPOu6nf/m0F1bJN4roLA2MsY6e5BriA0c=;\n\th=From:To:Subject:Date:In-Reply-To:References:From;\n\tb=QUUfL50nE1nrWvwp3FF/0dueXmgOAS5rAo7m4/GTd8ET4X40DlOW7tWfcMjrwj0xG\n\tdoS9MNEHhEuL25xMwDqAVpJuU9/Ky9UQaVE6eJ2gq1v4SmXap/C0ERzAUtjVuCHJyD\n\tS4Sn827nO5PFrfz8/7OUWJyNzEMfbhCInholNKSo=","From":"Laurent Pinchart ","To":"libcamera-devel@lists.libcamera.org","Subject":"[PATCH v3 10/37] libcamera: yaml_parser: Drop unneeded \\fn Doxygen\n\tcommands","Date":"Fri, 24 Apr 2026 02:00:32 +0300","Message-ID":"<20260423230059.3180987-11-laurent.pinchart@ideasonboard.com>","X-Mailer":"git-send-email 2.53.0","In-Reply-To":"<20260423230059.3180987-1-laurent.pinchart@ideasonboard.com>","References":"<20260423230059.3180987-1-laurent.pinchart@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":"","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\" "},"content":"There's no need to specify the function name in Doxygen comment blocks\nwith \\fn if the documentation directly precedes the function definition.\nDrop the unneeded \\fn.\n\nSigned-off-by: Laurent Pinchart \nReviewed-by: Barnabás Pőcze \nReviewed-by: Isaac Scott \n---\n src/libcamera/yaml_parser.cpp | 7 -------\n 1 file changed, 7 deletions(-)","diff":"diff --git a/src/libcamera/yaml_parser.cpp b/src/libcamera/yaml_parser.cpp\nindex c5f3af24a7df..347875769a44 100644\n--- a/src/libcamera/yaml_parser.cpp\n+++ b/src/libcamera/yaml_parser.cpp\n@@ -86,7 +86,6 @@ YamlObject::~YamlObject() = default;\n */\n \n /**\n- * \\fn YamlObject::size()\n * \\brief Retrieve the number of elements in a dictionary or list YamlObject\n *\n * This function retrieves the size of the YamlObject, defined as the number of\n@@ -529,7 +528,6 @@ YamlParserContext::~YamlParserContext()\n }\n \n /**\n- * \\fn YamlParserContext::init()\n * \\brief Initialize a parser with an opened file for parsing\n * \\param[in] fh The YAML file to parse\n *\n@@ -568,7 +566,6 @@ int YamlParserContext::yamlRead(void *data, unsigned char *buffer, size_t size,\n }\n \n /**\n- * \\fn YamlParserContext::nextEvent()\n * \\brief Get the next event\n *\n * Get the next event in the current YAML event stream, and return nullptr when\n@@ -597,7 +594,6 @@ YamlParserContext::EventPtr YamlParserContext::nextEvent()\n }\n \n /**\n- * \\fn YamlParserContext::parseContent()\n * \\brief Parse the content of a YAML document\n * \\param[in] yamlObject The result of YamlObject\n *\n@@ -636,7 +632,6 @@ int YamlParserContext::parseContent(YamlObject &yamlObject)\n }\n \n /**\n- * \\fn YamlParserContext::readValue()\n * \\brief Parse event scalar and fill its content into a string\n *\n * A helper function to parse a scalar event as string. The caller needs to\n@@ -651,7 +646,6 @@ std::string YamlParserContext::readValue(const EventPtr &event)\n }\n \n /**\n- * \\fn YamlParserContext::parseDictionaryOrList()\n * \\brief A helper function to abstract the common part of parsing dictionary or list\n * \\param[in] endEventType The YAML end event type (sequence or mapping)\n * \\param[in] parseItem The callback to handle an item\n@@ -695,7 +689,6 @@ int YamlParserContext::parseDictionaryOrList(yaml_event_type_t endEventType,\n }\n \n /**\n- * \\fn YamlParserContext::parseNextYamlObject()\n * \\brief Parse next YAML event and read it as a YamlObject\n * \\param[in] yamlObject The result of YamlObject\n * \\param[in] event The leading event of the object\n","prefixes":["v3","10/37"]}