espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-09-11 19:50:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

[docs] fix comment in spinel buffer (#6915)

Browse Source
This commit is contained in:
Li Cao
2021-08-11 13:22:55 -07:00
committed by GitHub
parent 2e625bfe39
commit 95c3f24b92
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/lib/spinel/spinel_buffer.hpp
+3 -3
View File
@@ -383,13 +383,13 @@ public:
* This method reads and copies bytes from the current output frame into a given buffer.
*
* The NCP buffer maintains a read offset for the current output frame being read. This method attempts to read
* the given number of bytes (@p aDataBufferLength) from the current frame and copies the bytes into the given
* the given number of bytes (@p aReadLength) from the current frame and copies the bytes into the given
* data buffer (@p aDataBuffer). It also moves the read offset forward accordingly. If there are fewer bytes
* remaining in current frame than the requested @p aReadLength, the available bytes are read/copied. This methods
* returns the number of bytes read from frame and copied into @p aDataBuffer.
*
* @param[in] aDataBuffer A pointer to a data buffer.
* @param[in] aReadLength Number of bytes to read.
* @param[in] aReadLength Number of bytes to read.
* @param[out] aDataBuffer A pointer to a data buffer.
*
* @returns The number of bytes read and copied into data buffer.
*