[v2,16/42] libcamera: yaml_parser: Drop unneeded \fn Doxygen commands
diff mbox series

Message ID 20260407153427.1825999-17-laurent.pinchart@ideasonboard.com
State New
Headers show
Series
  • libcamera: Global configuration file improvements
Related show

Commit Message

Laurent Pinchart April 7, 2026, 3:34 p.m. UTC 
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 <laurent.pinchart@ideasonboard.com>
Reviewed-by: Barnabás Pőcze <barnabas.pocze@ideasonboard.com>
---
 src/libcamera/yaml_parser.cpp | 7 -------
 1 file changed, 7 deletions(-)

Patch
diff mbox series 

diff --git a/src/libcamera/yaml_parser.cpp b/src/libcamera/yaml_parser.cpp
index bf098360191b..46369c6bc6a3 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
@@ -529,7 +528,6 @@  YamlParserContext::~YamlParserContext()
 }
 
 /**
- * \fn YamlParserContext::init()
  * \brief Initialize a parser with an opened file for parsing
  * \param[in] fh The YAML file to parse
  *
@@ -568,7 +566,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
@@ -597,7 +594,6 @@  YamlParserContext::EventPtr YamlParserContext::nextEvent()
 }
 
 /**
- * \fn YamlParserContext::parseContent()
  * \brief Parse the content of a YAML document
  * \param[in] yamlObject The result of YamlObject
  *
@@ -636,7 +632,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
@@ -651,7 +646,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
@@ -695,7 +689,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