FIFOBuffer::read(T*, std::size_t) documentation inaccurate #869

This commit is contained in:
Aleksandar Fabijanic 2015-06-23 21:02:18 -05:00
parent 9b32434999
commit cc9fb56705

View File

@ -175,9 +175,9 @@ public:
std::size_t read(T* pBuffer, std::size_t length)
/// Copies the data currently in the FIFO
/// into the supplied buffer.
/// Resizes the supplied buffer to the size of
/// data written to it.
/// into the supplied buffer, which must be
/// preallocated to at least the length size
/// before calling this function.
///
/// Returns the reference to the buffer.
{