NekoCWD/libcamera
NekoCWD/libcamera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 7 Wiki Activity Actions

libcamera: align the documentation for numeric error codes

Browse source 
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>
This commit is contained in:
Niklas Söderlund 2019-02-26 01:21:22 +01:00
parent 9aceed70a2
commit acb56ebef8
9 changed files with 31 additions and 33 deletions
Download patch file Download diff file Expand all files Collapse all files

8
src/libcamera/v4l2_device.cpp
View file

@ -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)
{