From patchwork Tue Jan 13 00:07:48 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Laurent Pinchart X-Patchwork-Id: 25736 Return-Path: X-Original-To: parsemail@patchwork.libcamera.org Delivered-To: parsemail@patchwork.libcamera.org Received: from lancelot.ideasonboard.com (lancelot.ideasonboard.com [92.243.16.209]) by patchwork.libcamera.org (Postfix) with ESMTPS id 2500BC3274 for ; Tue, 13 Jan 2026 00:08:57 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id D3A4461FE2; Tue, 13 Jan 2026 01:08:56 +0100 (CET) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="pF+0RGOu"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 6037F61FDF for ; Tue, 13 Jan 2026 01:08:54 +0100 (CET) Received: from pendragon.ideasonboard.com (81-175-209-152.bb.dnainternet.fi [81.175.209.152]) by perceval.ideasonboard.com (Postfix) with UTF8SMTPSA id B8ACBE01 for ; Tue, 13 Jan 2026 01:08:28 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1768262908; bh=dLCWBdsPXR0iaJdNPwthHIupa/eigp5hI/lxGEHYh1s=; h=From:To:Subject:Date:In-Reply-To:References:From; b=pF+0RGOuFn6sHDDLFTUuh+P4ok5MB2HPKSxEet7wwqABbZrNh6VGt+bsuPdiNszVd D3uj09ej+gCb05ZfjRd5Q07suza2rLh2Anjn8GAauDJy8XKmRiUeKZ/AM/qh+xl141 mDv7cHvf+2XJiy50W+PGyweXjRQnA2z63nzVdffM= From: Laurent Pinchart To: libcamera-devel@lists.libcamera.org Subject: [PATCH 16/36] libcamera: yaml_parser: Drop unneeded \fn Doxygen commands Date: Tue, 13 Jan 2026 02:07:48 +0200 Message-ID: <20260113000808.15395-17-laurent.pinchart@ideasonboard.com> X-Mailer: git-send-email 2.51.2 In-Reply-To: <20260113000808.15395-1-laurent.pinchart@ideasonboard.com> References: <20260113000808.15395-1-laurent.pinchart@ideasonboard.com> MIME-Version: 1.0 X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" There's no need to specify the function name in Doxygen comment blocks with \fn if the documentation directly precedes the function definition. Drop the unneeded \fn. Signed-off-by: Laurent Pinchart --- src/libcamera/yaml_parser.cpp | 7 ------- 1 file changed, 7 deletions(-) diff --git a/src/libcamera/yaml_parser.cpp b/src/libcamera/yaml_parser.cpp index 46c1fb9bce7e..0ef1f3ea303b 100644 --- a/src/libcamera/yaml_parser.cpp +++ b/src/libcamera/yaml_parser.cpp @@ -86,7 +86,6 @@ YamlObject::~YamlObject() = default; */ /** - * \fn YamlObject::size() * \brief Retrieve the number of elements in a dictionary or list YamlObject * * This function retrieves the size of the YamlObject, defined as the number of @@ -541,7 +540,6 @@ YamlParserContext::~YamlParserContext() } /** - * \fn YamlParserContext::init() * \brief Initialize a parser with an opened file for parsing * \param[in] fh The YAML file to parse * @@ -580,7 +578,6 @@ int YamlParserContext::yamlRead(void *data, unsigned char *buffer, size_t size, } /** - * \fn YamlParserContext::nextEvent() * \brief Get the next event * * Get the next event in the current YAML event stream, and return nullptr when @@ -609,7 +606,6 @@ YamlParserContext::EventPtr YamlParserContext::nextEvent() } /** - * \fn YamlParserContext::parseContent() * \brief Parse the content of a YAML document * \param[in] yamlObject The result of YamlObject * @@ -648,7 +644,6 @@ int YamlParserContext::parseContent(YamlObject &yamlObject) } /** - * \fn YamlParserContext::readValue() * \brief Parse event scalar and fill its content into a string * * A helper function to parse a scalar event as string. The caller needs to @@ -663,7 +658,6 @@ std::string YamlParserContext::readValue(EventPtr event) } /** - * \fn YamlParserContext::parseDictionaryOrList() * \brief A helper function to abstract the common part of parsing dictionary or list * \param[in] endEventType The YAML end event type (sequence or mapping) * \param[in] parseItem The callback to handle an item @@ -707,7 +701,6 @@ int YamlParserContext::parseDictionaryOrList(yaml_event_type_t endEventType, } /** - * \fn YamlParserContext::parseNextYamlObject() * \brief Parse next YAML event and read it as a YamlObject * \param[in] yamlObject The result of YamlObject * \param[in] event The leading event of the object