[5/6] libcamera: global_configuration: Drop "YAML" from function documentation
diff mbox series

Message ID 20260611011722.1767689-6-laurent.pinchart@ideasonboard.com
State Accepted
Headers show
Series
  • libcamera: Drop legacy mentions of YAML
Related show

Commit Message

Laurent Pinchart June 11, 2026, 1:17 a.m. UTC
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 src/libcamera/global_configuration.cpp | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Barnabás Pőcze June 15, 2026, 8:16 a.m. UTC | #1
2026. 06. 11. 3:17 keltezéssel, Laurent Pinchart írta:
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> ---

Reviewed-by: Barnabás Pőcze <barnabas.pocze@ideasonboard.com>


>   src/libcamera/global_configuration.cpp | 6 +++---
>   1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/src/libcamera/global_configuration.cpp b/src/libcamera/global_configuration.cpp
> index 46a285c3c4ea..6556cc524424 100644
> --- a/src/libcamera/global_configuration.cpp
> +++ b/src/libcamera/global_configuration.cpp
> @@ -258,7 +258,7 @@ unsigned int GlobalConfiguration::version() const
>    * \brief Retrieve the libcamera global configuration
>    *
>    * This returns the whole configuration stored in the top-level section
> - * `%configuration` of the YAML configuration file.
> + * `%configuration` of the configuration file.
>    *
>    * The requested part of the configuration can be accessed using \a ValueNode
>    * methods.
> @@ -274,7 +274,7 @@ const ValueNode &GlobalConfiguration::configuration() const
>    * \fn std::optional<T> GlobalConfiguration::option(const std::initializer_list<std::string_view> &confPath) const
>    * \brief Retrieve the value of configuration option \a confPath
>    * \tparam T The type of the retrieved configuration value
> - * \param[in] confPath Sequence of the YAML section names (excluding
> + * \param[in] confPath Sequence of the section names (excluding
>    * `%configuration`) leading to the requested option
>    * \return The value of the configuration item corresponding to \a confPath if
>    * it exists in the configuration file, or no value otherwise
> @@ -282,7 +282,7 @@ const ValueNode &GlobalConfiguration::configuration() const
>   
>   /**
>    * \brief Retrieve the value of configuration option \a confPath
> - * \param[in] confPath Sequence of the YAML section names (excluding
> + * \param[in] confPath Sequence of the section names (excluding
>    * `%configuration`) leading to the requested list option, separated by dots
>    * \return A vector of strings or no value if not found
>    */

Patch
diff mbox series

diff --git a/src/libcamera/global_configuration.cpp b/src/libcamera/global_configuration.cpp
index 46a285c3c4ea..6556cc524424 100644
--- a/src/libcamera/global_configuration.cpp
+++ b/src/libcamera/global_configuration.cpp
@@ -258,7 +258,7 @@  unsigned int GlobalConfiguration::version() const
  * \brief Retrieve the libcamera global configuration
  *
  * This returns the whole configuration stored in the top-level section
- * `%configuration` of the YAML configuration file.
+ * `%configuration` of the configuration file.
  *
  * The requested part of the configuration can be accessed using \a ValueNode
  * methods.
@@ -274,7 +274,7 @@  const ValueNode &GlobalConfiguration::configuration() const
  * \fn std::optional<T> GlobalConfiguration::option(const std::initializer_list<std::string_view> &confPath) const
  * \brief Retrieve the value of configuration option \a confPath
  * \tparam T The type of the retrieved configuration value
- * \param[in] confPath Sequence of the YAML section names (excluding
+ * \param[in] confPath Sequence of the section names (excluding
  * `%configuration`) leading to the requested option
  * \return The value of the configuration item corresponding to \a confPath if
  * it exists in the configuration file, or no value otherwise
@@ -282,7 +282,7 @@  const ValueNode &GlobalConfiguration::configuration() const
 
 /**
  * \brief Retrieve the value of configuration option \a confPath
- * \param[in] confPath Sequence of the YAML section names (excluding
+ * \param[in] confPath Sequence of the section names (excluding
  * `%configuration`) leading to the requested list option, separated by dots
  * \return A vector of strings or no value if not found
  */