[{"id":37618,"web_url":"https://patchwork.libcamera.org/comment/37618/","msgid":"","date":"2026-01-13T16:38:11","subject":"Re: [PATCH 16/36] libcamera: yaml_parser: Drop unneeded \\fn Doxygen\n\tcommands","submitter":{"id":216,"url":"https://patchwork.libcamera.org/api/people/216/","name":"Barnabás Pőcze","email":"barnabas.pocze@ideasonboard.com"},"content":"2026. 01. 13. 1:07 keltezéssel, Laurent Pinchart írta:\n> There's no need to specify the function name in Doxygen comment blocks\n> with \\fn if the documentation directly precedes the function definition.\n> Drop the unneeded \\fn.\n> \n> Signed-off-by: Laurent Pinchart \n> ---\n\nThe whole `YamlParserContext` is not visible to doxygen, no? At least I see\n`#ifndef __DOXYGEN__` around it. And even if was, private things are excluded\nby doxygen.\n\nReviewed-by: Barnabás Pőcze \n\n\n> src/libcamera/yaml_parser.cpp | 7 -------\n> 1 file changed, 7 deletions(-)\n> \n> diff --git a/src/libcamera/yaml_parser.cpp b/src/libcamera/yaml_parser.cpp\n> index 46c1fb9bce7e..0ef1f3ea303b 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> @@ -541,7 +540,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> @@ -580,7 +578,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> @@ -609,7 +606,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> @@ -648,7 +644,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> @@ -663,7 +658,6 @@ std::string YamlParserContext::readValue(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> @@ -707,7 +701,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","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 8D323BDCBF\n\tfor ;\n\tTue, 13 Jan 2026 16:38:16 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id C5A0261FA3;\n\tTue, 13 Jan 2026 17:38:15 +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 EB83661FA0\n\tfor ;\n\tTue, 13 Jan 2026 17:38:13 +0100 (CET)","from [192.168.33.30] (185.221.143.114.nat.pool.zt.hu\n\t[185.221.143.114])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id C1BC050A;\n\tTue, 13 Jan 2026 17:37:47 +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=\"vMTh8GQF\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1768322267;\n\tbh=V05dkApQHDWCF0tgMKp2F5o3xr2eXg+xKXFDzqDKFNI=;\n\th=Date:Subject:To:References:From:In-Reply-To:From;\n\tb=vMTh8GQFiQijpVmrsTivh2Uj2NHYTFdZ35EDWhIJVdbpAepXLBQDe3BX2+AlSZ+qS\n\tKoPhuNH2FukLiMI2PjBY21RwlCSUQIYDaB0CqOLlMM8Rfy8Evk58boRENXy160fRTn\n\tRMTcl6e+ID856MyPBDyl3G8h1JSMiVaQXCmxbQ+Y=","Message-ID":"","Date":"Tue, 13 Jan 2026 17:38:11 +0100","MIME-Version":"1.0","User-Agent":"Mozilla Thunderbird","Subject":"Re: [PATCH 16/36] libcamera: yaml_parser: Drop unneeded \\fn Doxygen\n\tcommands","To":"Laurent Pinchart ,\n\tlibcamera-devel@lists.libcamera.org","References":"<20260113000808.15395-1-laurent.pinchart@ideasonboard.com>\n\t<20260113000808.15395-17-laurent.pinchart@ideasonboard.com>","From":"=?utf-8?q?Barnab=C3=A1s_P=C5=91cze?= ","Content-Language":"en-US, hu-HU","In-Reply-To":"<20260113000808.15395-17-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\" "}},{"id":37624,"web_url":"https://patchwork.libcamera.org/comment/37624/","msgid":"<20260113202901.GB30544@pendragon.ideasonboard.com>","date":"2026-01-13T20:29:01","subject":"Re: [PATCH 16/36] libcamera: yaml_parser: Drop unneeded \\fn Doxygen\n\tcommands","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"On Tue, Jan 13, 2026 at 05:38:11PM +0100, Barnabás Pőcze wrote:\n> 2026. 01. 13. 1:07 keltezéssel, Laurent Pinchart írta:\n> > There's no need to specify the function name in Doxygen comment blocks\n> > with \\fn if the documentation directly precedes the function definition.\n> > Drop the unneeded \\fn.\n> > \n> > Signed-off-by: Laurent Pinchart \n> > ---\n> \n> The whole `YamlParserContext` is not visible to doxygen, no? At least I see\n> `#ifndef __DOXYGEN__` around it. And even if was, private things are excluded\n> by doxygen.\n\nYou're right. I think it was initially documented for our internal use.\nWe could drop the documentation, but I think it's still useful.\n\n> Reviewed-by: Barnabás Pőcze \n> \n> > src/libcamera/yaml_parser.cpp | 7 -------\n> > 1 file changed, 7 deletions(-)\n> > \n> > diff --git a/src/libcamera/yaml_parser.cpp b/src/libcamera/yaml_parser.cpp\n> > index 46c1fb9bce7e..0ef1f3ea303b 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> > @@ -541,7 +540,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> > @@ -580,7 +578,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> > @@ -609,7 +606,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> > @@ -648,7 +644,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> > @@ -663,7 +658,6 @@ std::string YamlParserContext::readValue(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> > @@ -707,7 +701,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","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 7ADDBBE08B\n\tfor ;\n\tTue, 13 Jan 2026 20:29:25 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 7F3B161FC3;\n\tTue, 13 Jan 2026 21:29:24 +0100 (CET)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id E41D261FA0\n\tfor ;\n\tTue, 13 Jan 2026 21:29:22 +0100 (CET)","from pendragon.ideasonboard.com (81-175-209-152.bb.dnainternet.fi\n\t[81.175.209.152])\n\tby perceval.ideasonboard.com (Postfix) with UTF8SMTPSA id 829B2229;\n\tTue, 13 Jan 2026 21:28:56 +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=\"ZzUO7W5m\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1768336136;\n\tbh=jWzrvEw6tfUY43zUa+Ps3sf1FxHyHQKVUZGHvl8G+HE=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=ZzUO7W5mL6CLg43YV34HgqY5W2RzZRd3f7w3xsaanPGKhdOW6hgB/hb2GZxoMc5Jh\n\tH3Q3GauJmgfSG95k/2YF1TYYoTzXqDyN1WzAMsGNpe89pnbFMlpfk3fi+Ww5wufr4R\n\tMypKETEp3mIg+pc4H9GdcIH+s0JLxKUgFjrlDGIo=","Date":"Tue, 13 Jan 2026 22:29:01 +0200","From":"Laurent Pinchart ","To":"=?utf-8?q?Barnab=C3=A1s_P=C5=91cze?= ","Cc":"libcamera-devel@lists.libcamera.org","Subject":"Re: [PATCH 16/36] libcamera: yaml_parser: Drop unneeded \\fn Doxygen\n\tcommands","Message-ID":"<20260113202901.GB30544@pendragon.ideasonboard.com>","References":"<20260113000808.15395-1-laurent.pinchart@ideasonboard.com>\n\t<20260113000808.15395-17-laurent.pinchart@ideasonboard.com>\n\t","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","Content-Transfer-Encoding":"8bit","In-Reply-To":"","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\" "}}]