summaryrefslogtreecommitdiff
path: root/src/libcamera/buffer.cpp
diff options
context:
space:
mode:
authorNiklas Söderlund <niklas.soderlund@ragnatech.se>2019-02-26 01:21:22 +0100
committerNiklas Söderlund <niklas.soderlund@ragnatech.se>2019-02-27 17:36:30 +0100
commitacb56ebef833e0189f4d867c144363ef522ba740 (patch)
tree744d20026ba14407f5f9924a8ec380dba957b5c9 /src/libcamera/buffer.cpp
parent9aceed70a2879802c7fe00ea2c0455ccd5c14f07 (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/buffer.cpp')
-rw-r--r--src/libcamera/buffer.cpp6
1 files changed, 3 insertions, 3 deletions
diff --git a/src/libcamera/buffer.cpp b/src/libcamera/buffer.cpp
index 9ec372c2..80dd9c85 100644
--- a/src/libcamera/buffer.cpp
+++ b/src/libcamera/buffer.cpp
@@ -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()
{