PawletOS/external_libcamera
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

libcamera: byte_stream_buffer: Fix documentation of read() and write()

Browse Source 
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>
This commit is contained in:
Jacopo Mondi
2020-01-13 13:40:46 +01:00
committed by Laurent Pinchart
parent 427c37f671
commit 34fc1f38bd
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/libcamera/byte_stream_buffer.cpp
View File

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