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>
This commit is contained in:
Jacopo Mondi
2021-04-19 10:25:44 +02:00
parent 787c90027c
commit 99de822436
+3 -2
View File
@@ -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.
*/