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>
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

View File

@@ -71,7 +71,7 @@ Plane::~Plane()
* The \a fd dmabuf file handle is duplicated and stored. The caller may close
* the original file handle.
*
* \return 0 on success or a negative error value otherwise.
* \return 0 on success or a negative error code otherwise
*/
int Plane::setDmabuf(int fd, unsigned int length)
{
@@ -106,7 +106,7 @@ int Plane::setDmabuf(int fd, unsigned int length)
*
* \sa setDmaBuf()
*
* \return 0 on success or a negative error value otherwise.
* \return 0 on success or a negative error code otherwise
*/
int Plane::mmap()
{
@@ -133,7 +133,7 @@ int Plane::mmap()
*
* Unmap the memory mapped by an earlier call to mmap().
*
* \return 0 on success or a negative error value otherwise.
* \return 0 on success or a negative error code otherwise
*/
int Plane::munmap()
{