summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorJacopo Mondi <jacopo@jmondi.org>2020-01-13 13:40:46 +0100
committerLaurent Pinchart <laurent.pinchart@ideasonboard.com>2020-03-06 18:10:42 +0200
commit34fc1f38bd3cfb85c9888301bcafdbca2f71b6d2 (patch)
treea14c301aa6ce04bdb0ee66067682e901b6915ea1 /src
parent427c37f671a91473f1b0495929daa28b712595e9 (diff)
libcamera: byte_stream_buffer: Fix documentation of read() and write()
The documentation of the read() and write() functions refer to non existent 'size' and 'data' parameters in their brief. Fix them. Signed-off-by: Jacopo Mondi <jacopo@jmondi.org> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
Diffstat (limited to 'src')
-rw-r--r--src/libcamera/byte_stream_buffer.cpp4
1 files changed, 2 insertions, 2 deletions
diff --git a/src/libcamera/byte_stream_buffer.cpp b/src/libcamera/byte_stream_buffer.cpp
index 23d624dd..cd1d8a36 100644
--- a/src/libcamera/byte_stream_buffer.cpp
+++ b/src/libcamera/byte_stream_buffer.cpp
@@ -225,7 +225,7 @@ int ByteStreamBuffer::skip(size_t size)
/**
* \fn template<typename T> int ByteStreamBuffer::read(T *t)
- * \brief Read \a size \a data from the managed memory buffer
+ * \brief Read data from the managed memory buffer into \a t
* \param[out] t Pointer to the memory containing the read data
* \return 0 on success, a negative error code otherwise
* \retval -EACCES attempting to read from a write buffer
@@ -234,7 +234,7 @@ int ByteStreamBuffer::skip(size_t size)
/**
* \fn template<typename T> int ByteStreamBuffer::write(const T *t)
- * \brief Write \a data of \a size to the managed memory buffer
+ * \brief Write \a t to the managed memory buffer
* \param[in] t The data to write to memory
* \return 0 on success, a negative error code otherwise
* \retval -EACCES attempting to write to a read buffer