licamera: controls: Update ControlList::get() documentation
The ControlList::get(const Control<T> &ctrl) function has been modified in commit1c4d480185("libcamera: controls: Use std::optional to handle invalid control values") to return an std::optional<>, but its documentation wasn't updated. Fix it. Fixes:1c4d480185("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>
This commit is contained in:
@@ -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
|
||||
*/
|
||||
|
||||
/**
|
||||
|
||||
Reference in New Issue
Block a user