diff options
| author | Jacopo Mondi <jacopo@jmondi.org> | 2021-04-19 10:25:44 +0200 |
|---|---|---|
| committer | Jacopo Mondi <jacopo@jmondi.org> | 2021-05-06 15:09:18 +0200 |
| commit | 99de8224366ac40429c27425f7c6d9e9aaf258e5 (patch) | |
| tree | 94f3812a4143c7fbbe3e8d06c817babdb642d81f | |
| parent | 787c90027c4c9bcbe455030dff3f454f1999038e (diff) | |
libcamera: buffer: Re-work setRequest() documentation
I got fooled by the documentation of setRequest() implying that the
function is meant to be called by pipeline handlers only, which it is
used in the Request class at Request::addBuffer() and Request::reuse()
time.
Rework the documentation to report that.
Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Jacopo Mondi <jacopo@jmondi.org>
| -rw-r--r-- | src/libcamera/buffer.cpp | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/src/libcamera/buffer.cpp b/src/libcamera/buffer.cpp index 7635226b..ca999429 100644 --- a/src/libcamera/buffer.cpp +++ b/src/libcamera/buffer.cpp @@ -191,8 +191,9 @@ FrameBuffer::FrameBuffer(const std::vector<Plane> &planes, unsigned int cookie) * \brief Set the request this buffer belongs to * \param[in] request Request to set * - * The intended callers of this method are pipeline handlers and only for - * buffers that are internal to the pipeline. + * For buffers added to requests by applications, this method is called by + * Request::addBuffer() or Request::reuse(). For buffers internal to pipeline + * handlers, it is called by the pipeline handlers themselves. * * \todo Shall be hidden from applications with a d-pointer design. */ |