From 31a817cda2fa48f284aa66fd1b35bbaa0bae1f60 Mon Sep 17 00:00:00 2001 From: Laurent Pinchart Date: Sun, 19 Oct 2025 02:42:35 +0300 Subject: [PATCH] libcamera: yaml_parser: Drop unneeded \fn Doxygen commands MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 Reviewed-by: Barnabás Pőcze Reviewed-by: Isaac Scott --- 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 00c0372c..2dcfcb4a 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 @@ -531,7 +530,6 @@ YamlParserContext::~YamlParserContext() } /** - * \fn YamlParserContext::init() * \brief Initialize a parser with an opened file for parsing * \param[in] fh The YAML file to parse * @@ -570,7 +568,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 @@ -599,7 +596,6 @@ YamlParserContext::EventPtr YamlParserContext::nextEvent() } /** - * \fn YamlParserContext::parseContent() * \brief Parse the content of a YAML document * \param[in] yamlObject The result of YamlObject * @@ -638,7 +634,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 @@ -653,7 +648,6 @@ std::string YamlParserContext::readValue(const 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 @@ -697,7 +691,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