{"id":25738,"url":"https://patchwork.libcamera.org/api/patches/25738/?format=json","web_url":"https://patchwork.libcamera.org/patch/25738/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/projects/1/?format=json","name":"libcamera","link_name":"libcamera","list_id":"libcamera_core","list_email":"libcamera-devel@lists.libcamera.org","web_url":"","scm_url":"","webscm_url":""},"msgid":"<20260113000808.15395-19-laurent.pinchart@ideasonboard.com>","date":"2026-01-13T00:07:50","name":"[18/36] libcamera: yaml_object: Miscellaneous documentation improvements","commit_ref":null,"pull_url":null,"state":"new","archived":false,"hash":"b8120548c85790a44512e669da8b40818175a151","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/?format=json","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/25738/mbox/","series":[{"id":5703,"url":"https://patchwork.libcamera.org/api/series/5703/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=5703","date":"2026-01-13T00:07:32","name":"libcamera: Global configuration file improvements","version":1,"mbox":"https://patchwork.libcamera.org/series/5703/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/25738/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/25738/checks/","tags":{},"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 9FD9BBDCBF\n\tfor ;\n\tTue, 13 Jan 2026 00:08:59 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 5969E61FC8;\n\tTue, 13 Jan 2026 01:08:59 +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 2F18061FC8\n\tfor ;\n\tTue, 13 Jan 2026 01:08:58 +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 4073EBCA\n\tfor ;\n\tTue, 13 Jan 2026 01:08:32 +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=\"t0ZWsMyl\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1768262912;\n\tbh=FdsClevNyNQuTBJXJy7gOR1uROX9L0CA1y+LtpZ8j7c=;\n\th=From:To:Subject:Date:In-Reply-To:References:From;\n\tb=t0ZWsMylLt5+E0JElhJtncbuVz/R+TsH/YUcgB+jyksANGHJJSwj+b77Bz3W0NdNm\n\tGNYQ/+3IubMKy7pPetNSxrDJajlnTnpnrHQObF/ak8npDdc9S6+1PKEhJUrhsSPKNN\n\tOxp4ub/fTgUYknx6lBuRBMeHVWGLBwqXYds2c6DI=","From":"Laurent Pinchart ","To":"libcamera-devel@lists.libcamera.org","Subject":"[PATCH 18/36] libcamera: yaml_object: Miscellaneous documentation\n\timprovements","Date":"Tue, 13 Jan 2026 02:07:50 +0200","Message-ID":"<20260113000808.15395-19-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","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\" "},"content":"Fix a few documentation issues:\n\n- Drop unneeded \\fn\n- Sort \\brief and \\tparam correctly\n- Add missing \\tparam and \\param\n- Explain the T and U template parameters for get()\n- Standardize the naming of dictionary keys as \"key\"\n- Fix typo\n\nSigned-off-by: Laurent Pinchart \n---\n src/libcamera/yaml_object.cpp | 29 ++++++++++++++++-------------\n 1 file changed, 16 insertions(+), 13 deletions(-)","diff":"diff --git a/src/libcamera/yaml_object.cpp b/src/libcamera/yaml_object.cpp\nindex 5e92189fdb8e..4328ccbff8f1 100644\n--- a/src/libcamera/yaml_object.cpp\n+++ b/src/libcamera/yaml_object.cpp\n@@ -81,7 +81,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@@ -104,8 +103,8 @@ std::size_t YamlObject::size() const\n \n /**\n * \\fn template YamlObject::get() const\n- * \\tparam T Type of the value\n * \\brief Parse the YamlObject as a \\a T value\n+ * \\tparam T Type of the value\n *\n * This function parses the value of the YamlObject as a \\a T object, and\n * returns the value. If parsing fails (usually because the YamlObject doesn't\n@@ -120,11 +119,14 @@ std::size_t YamlObject::size() const\n /**\n * \\fn template YamlObject::get(U &&defaultValue) const\n * \\brief Parse the YamlObject as a \\a T value\n+ * \\tparam T Type of the value\n+ * \\tparam U Type of the default value\n * \\param[in] defaultValue The default value when failing to parse\n *\n * This function parses the value of the YamlObject as a \\a T object, and\n * returns the value. If parsing fails (usually because the YamlObject doesn't\n- * store a \\a T value), the \\a defaultValue is returned.\n+ * store a \\a T value), the \\a defaultValue is returned. Type \\a U must be\n+ * convertible to type \\a T.\n *\n * Unlike the get() function, this overload does not support std::vector for the\n * type \\a T.\n@@ -135,6 +137,7 @@ std::size_t YamlObject::size() const\n /**\n * \\fn template YamlObject::set(T &&value)\n * \\brief Set the value of a YamlObject\n+ * \\tparam T Type of the value\n * \\param[in] value The value\n *\n * This function sets the value stored in a YamlObject to \\a value. The value is\n@@ -363,8 +366,8 @@ template struct YamlObject::Accessor>;\n */\n \n /**\n- * \\fn YamlObject::operator[](std::size_t index) const\n * \\brief Retrieve the element from list YamlObject by index\n+ * \\param[in] index The element index\n *\n * This function retrieves an element of the YamlObject. Only YamlObject\n * instances of List type associate elements with index, calling this function\n@@ -382,13 +385,13 @@ const YamlObject &YamlObject::operator[](std::size_t index) const\n }\n \n /**\n- * \\fn YamlObject::contains()\n * \\brief Check if an element of a dictionary exists\n+ * \\param[in] key The element key\n *\n- * This function check if the YamlObject contains an element. Only YamlObject\n- * instances of Dictionary type associate elements with names, calling this\n- * function on other types of instances is invalid and results in undefined\n- * behaviour.\n+ * This function check if the YamlObject contains an element for the given \\a\n+ * key. Only YamlObject instances of Dictionary type associate elements with\n+ * keys, calling this function on other types of instances is invalid and\n+ * results in undefined behaviour.\n *\n * \\return True if an element exists, false otherwise\n */\n@@ -398,11 +401,11 @@ bool YamlObject::contains(std::string_view key) const\n }\n \n /**\n- * \\fn YamlObject::operator[](std::string_view key) const\n- * \\brief Retrieve a member by name from the dictionary\n+ * \\brief Retrieve a member by key from the dictionary\n+ * \\param[in] key The element key\n *\n- * This function retrieve a member of a YamlObject by name. Only YamlObject\n- * instances of Dictionary type associate elements with names, calling this\n+ * This function retrieves a member of a YamlObject by \\a key. Only YamlObject\n+ * instances of Dictionary type associate elements with keys, calling this\n * function on other types of instances or with a nonexistent key results in an\n * empty object.\n *\n","prefixes":["18/36"]}