[libcamera-devel,2/2] licamera: controls: Update ControlList::get() documentation
diff mbox series

Message ID 20220719210258.5602-2-laurent.pinchart@ideasonboard.com
State Accepted
Commit 38136f9e11d1e1af3880bc3382e97e5a7250568d
Headers show
Series
  • [libcamera-devel,1/2] licamera: controls: Drop unnecessary template qualifiers in documentation
Related show

Commit Message

Laurent Pinchart July 19, 2022, 9:02 p.m. UTC 
The ControlList::get(const Control<T> &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 <laurent.pinchart@ideasonboard.com>
---
 src/libcamera/controls.cpp | 10 ++--------
 1 file changed, 2 insertions(+), 8 deletions(-)

Patch
diff mbox series 

diff --git a/src/libcamera/controls.cpp b/src/libcamera/controls.cpp
index 3fd535f204b2..20c27e65e725 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<T> containing the control value, or std::nullopt if
+ * the control \a ctrl is not present in the list
  */
 
 /**