From acb56ebef833e0189f4d867c144363ef522ba740 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Niklas=20S=C3=B6derlund?= Date: Tue, 26 Feb 2019 01:21:22 +0100 Subject: libcamera: align the documentation for numeric error codes MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Rapid growth of the library have resulted in slightly different wording to document that a function returns 0 on success or a negative error code otherwise. Align all different variations. Signed-off-by: Niklas Söderlund Reviewed-by: Jacopo Mondi Acked-by: Laurent Pinchart --- src/libcamera/v4l2_device.cpp | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'src/libcamera/v4l2_device.cpp') diff --git a/src/libcamera/v4l2_device.cpp b/src/libcamera/v4l2_device.cpp index 24e11555..31200a6e 100644 --- a/src/libcamera/v4l2_device.cpp +++ b/src/libcamera/v4l2_device.cpp @@ -247,7 +247,7 @@ V4L2Device::~V4L2Device() /** * \brief Open a V4L2 device and query its capabilities - * \return 0 on success, or a negative error code otherwise + * \return 0 on success or a negative error code otherwise */ int V4L2Device::open() { @@ -365,7 +365,7 @@ std::string V4L2Device::logPrefix() const * \brief Retrieve the image format set on the V4L2 device * \param[out] format The image format applied on the device * - * \return 0 for success, a negative error code otherwise + * \return 0 on success or a negative error code otherwise */ int V4L2Device::getFormat(V4L2DeviceFormat *format) { @@ -380,7 +380,7 @@ int V4L2Device::getFormat(V4L2DeviceFormat *format) * Apply the supplied \a format to the device, and return the actually * applied format parameters, as \ref V4L2Device::getFormat would do. * - * \return 0 for success, a negative error code otherwise + * \return 0 on success or a negative error code otherwise */ int V4L2Device::setFormat(V4L2DeviceFormat *format) { @@ -697,7 +697,7 @@ int V4L2Device::releaseBuffers() * \todo Support output devices (bytesused, ...) * \todo Support imported buffers (dmabuf fd) * - * \return 0 on success or a negative error number otherwise + * \return 0 on success or a negative error code otherwise */ int V4L2Device::queueBuffer(Buffer *buffer) { -- cgit v1.2.1