[libcamera-devel,v5,12/17] libcamera: buffer: Re-work setRequest() documentation
diff mbox series

Message ID 20210503104152.34048-13-jacopo@jmondi.org
State Accepted
Headers show
Series
  • Support SensorTimestamp metadata
Related show

Commit Message

Jacopo Mondi May 3, 2021, 10:41 a.m. UTC 
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>
---
 src/libcamera/buffer.cpp | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

Patch
diff mbox series 

diff --git a/src/libcamera/buffer.cpp b/src/libcamera/buffer.cpp
index 7635226b9045..ca999429dce5 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.
  */