From 38136f9e11d1e1af3880bc3382e97e5a7250568d Mon Sep 17 00:00:00 2001 From: Laurent Pinchart Date: Tue, 19 Jul 2022 23:50:29 +0300 Subject: licamera: controls: Update ControlList::get() documentation The ControlList::get(const Control &ctrl) function has been modified in commit 1c4d48018505 ("libcamera: controls: Use std::optional to handle invalid control values") to return an std::optional<>, but its documentation wasn't updated. Fix it. Fixes: 1c4d48018505 ("libcamera: controls: Use std::optional to handle invalid control values") Signed-off-by: Laurent Pinchart Reviewed-by: Jacopo Mondi Reviewed-by: Umang Jain --- src/libcamera/controls.cpp | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/src/libcamera/controls.cpp b/src/libcamera/controls.cpp index e3afc915..39c29488 100644 --- a/src/libcamera/controls.cpp +++ b/src/libcamera/controls.cpp @@ -958,14 +958,8 @@ bool ControlList::contains(unsigned int id) const * \brief Get the value of control \a ctrl * \param[in] ctrl The control * - * The behaviour is undefined if the control \a ctrl is not present in the - * list. Use ControlList::contains() to test for the presence of a control in - * the list before retrieving its value. - * - * The control value type shall match the type T, otherwise the behaviour is - * undefined. - * - * \return The control value + * \return A std::optional containing the control value, or std::nullopt if + * the control \a ctrl is not present in the list */ /** -- cgit v1.2.1