diff options
| author | Laurent Pinchart <laurent.pinchart@ideasonboard.com> | 2022-07-19 23:50:29 +0300 |
|---|---|---|
| committer | Laurent Pinchart <laurent.pinchart@ideasonboard.com> | 2022-07-20 13:25:00 +0300 |
| commit | 38136f9e11d1e1af3880bc3382e97e5a7250568d (patch) | |
| tree | 68227ecd877fbab07481fcead44236ffef7c55fe | |
| parent | e70a3122a9994fa12a3ba1f347c9384933544764 (diff) | |
licamera: controls: Update ControlList::get() documentation
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>
Reviewed-by: Jacopo Mondi <jacopo@jmondi.org>
Reviewed-by: Umang Jain <umang.jain@ideasonboard.com>
| -rw-r--r-- | src/libcamera/controls.cpp | 10 |
1 files 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<T> containing the control value, or std::nullopt if + * the control \a ctrl is not present in the list */ /** |