From 643cc403fec2e568dbd7b4dbce8edbaa9eaea98e Mon Sep 17 00:00:00 2001 From: Jacopo Mondi <jacopo@jmondi.org> Date: Wed, 25 Aug 2021 17:45:33 +0200 Subject: libcamera: camera configuration: Add at() function in doc The documentation suggests to use CameraConfiguration::operator[] to access the StreamConfiguration it contains, but as CameraConfiguration instances are generated by the Camera class and are returned wrapped in a unique_ptr<>, the usage of operator[] would require an awkward syntax such as (*config)[i]. Better to suggest the usage of the CameraConfiguration::at() function instead to access the StreamConfigurations. Signed-off-by: Jacopo Mondi <jacopo@jmondi.org> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> --- src/libcamera/camera.cpp | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/libcamera/camera.cpp b/src/libcamera/camera.cpp index c20e0501..98438312 100644 --- a/src/libcamera/camera.cpp +++ b/src/libcamera/camera.cpp @@ -114,9 +114,9 @@ LOG_DECLARE_CATEGORY(Camera) * The CameraConfiguration holds an ordered list of stream configurations. It * supports iterators and operates as a vector of StreamConfiguration instances. * The stream configurations are inserted by addConfiguration(), and the - * operator[](int) returns a reference to the StreamConfiguration based on its - * insertion index. Accessing a stream configuration with an invalid index - * results in undefined behaviour. + * at() function or operator[] return a reference to the StreamConfiguration + * based on its insertion index. Accessing a stream configuration with an + * invalid index results in undefined behaviour. * * CameraConfiguration instances are retrieved from the camera with * Camera::generateConfiguration(). Applications may then inspect the -- cgit v1.2.1