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:
@@ -108,7 +108,8 @@ FrameBufferAllocator::~FrameBufferAllocator()
|
||||
* Upon successful allocation, the allocated buffers can be retrieved with the
|
||||
* buffers() method.
|
||||
*
|
||||
* \return 0 on success or a negative error code otherwise
|
||||
* \return The number of allocated buffers on success or a negative error code
|
||||
* otherwise
|
||||
* \retval -EACCES The camera is not in a state where buffers can be allocated
|
||||
* \retval -EINVAL The \a stream does not belong to the camera or the stream is
|
||||
* not part of the active camera configuration
|
||||
@@ -140,12 +141,8 @@ int FrameBufferAllocator::allocate(Stream *stream)
|
||||
return -EBUSY;
|
||||
}
|
||||
|
||||
int ret = camera_->pipe_->exportFrameBuffers(camera_.get(), stream,
|
||||
&buffers_[stream]);
|
||||
if (ret)
|
||||
return ret;
|
||||
|
||||
return 0;
|
||||
return camera_->pipe_->exportFrameBuffers(camera_.get(), stream,
|
||||
&buffers_[stream]);
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
Reference in New Issue
Block a user