libcamera: Fix documentation of buffer allocation/export functions

The V4L2VideoDevice::exportBuffers(),
PipelineHandler::exportFrameBuffers() and
FrameBufferAllocator::allocate() functions all return the number of
allocated buffers on success, but are documented as returning 0 in that
case. Fix their documentation.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>
This commit is contained in:
Laurent Pinchart
2020-01-22 18:46:00 +02:00
parent 667f53b522
commit ce2ea24fb4
3 changed files with 8 additions and 9 deletions
+2 -1
View File
@@ -973,7 +973,8 @@ int V4L2VideoDevice::requestBuffers(unsigned int count)
* \brief Allocate buffers from the video device
* \param[in] count Number of buffers to allocate
* \param[out] buffers Vector to store allocated buffers
* \return 0 on success or a negative error code otherwise
* \return The number of allocated buffers on success or a negative error code
* otherwise
*/
int V4L2VideoDevice::exportBuffers(unsigned int count,
std::vector<std::unique_ptr<FrameBuffer>> *buffers)