diff options
| author | Niklas Söderlund <niklas.soderlund@ragnatech.se> | 2019-02-26 01:21:22 +0100 |
|---|---|---|
| committer | Niklas Söderlund <niklas.soderlund@ragnatech.se> | 2019-02-27 17:36:30 +0100 |
| commit | acb56ebef833e0189f4d867c144363ef522ba740 (patch) | |
| tree | 744d20026ba14407f5f9924a8ec380dba957b5c9 /src/libcamera/v4l2_device.cpp | |
| parent | 9aceed70a2879802c7fe00ea2c0455ccd5c14f07 (diff) | |
libcamera: align the documentation for numeric error codes
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 <niklas.soderlund@ragnatech.se>
Reviewed-by: Jacopo Mondi <jacopo@jmondi.org>
Acked-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Diffstat (limited to 'src/libcamera/v4l2_device.cpp')
| -rw-r--r-- | src/libcamera/v4l2_device.cpp | 8 |
1 files changed, 4 insertions, 4 deletions
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) { |