summaryrefslogtreecommitdiff
path: root/src/libcamera/pipeline_handler.cpp
diff options
context:
space:
mode:
authorLaurent Pinchart <laurent.pinchart@ideasonboard.com>2020-01-20 13:24:50 +0200
committerLaurent Pinchart <laurent.pinchart@ideasonboard.com>2020-01-22 18:46:00 +0200
commitce2ea24fb46f924bda14721c7cee0d2e4ea0d74f (patch)
treee6ce88cd1a6aae47315e83bf488dec24731236e9 /src/libcamera/pipeline_handler.cpp
parent667f53b522d6181ca3794e0d45d52bc1b069a513 (diff)
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>
Diffstat (limited to 'src/libcamera/pipeline_handler.cpp')
-rw-r--r--src/libcamera/pipeline_handler.cpp3
1 files changed, 2 insertions, 1 deletions
diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp
index 669097f6..01b9ede3 100644
--- a/src/libcamera/pipeline_handler.cpp
+++ b/src/libcamera/pipeline_handler.cpp
@@ -316,7 +316,8 @@ const ControlInfoMap &PipelineHandler::controls(Camera *camera)
*
* The only intended caller is the FrameBufferAllocator helper.
*
- * \return 0 on success or a negative error code otherwise
+ * \return The number of allocated buffers on success or a negative error code
+ * otherwise
*/
/**