util/{Foreign,Static}FifoBuffer: update API documentation
This commit is contained in:
parent
52cb425e33
commit
d68772d45a
@ -144,7 +144,7 @@ public:
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Prepares writing. Returns a buffer range which may be written.
|
* Prepares writing. Returns a buffer range which may be written.
|
||||||
* When you are finished, call append().
|
* When you are finished, call Append().
|
||||||
*/
|
*/
|
||||||
Range Write() {
|
Range Write() {
|
||||||
if (IsEmpty())
|
if (IsEmpty())
|
||||||
@ -172,7 +172,7 @@ public:
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Expands the tail of the buffer, after data has been written to
|
* Expands the tail of the buffer, after data has been written to
|
||||||
* the buffer returned by write().
|
* the buffer returned by Write().
|
||||||
*/
|
*/
|
||||||
void Append(size_type n) {
|
void Append(size_type n) {
|
||||||
assert(tail <= capacity);
|
assert(tail <= capacity);
|
||||||
|
@ -88,7 +88,7 @@ public:
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Prepares writing. Returns a buffer range which may be written.
|
* Prepares writing. Returns a buffer range which may be written.
|
||||||
* When you are finished, call append().
|
* When you are finished, call Append().
|
||||||
*/
|
*/
|
||||||
Range Write() {
|
Range Write() {
|
||||||
if (IsEmpty())
|
if (IsEmpty())
|
||||||
@ -101,7 +101,7 @@ public:
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Expands the tail of the buffer, after data has been written to
|
* Expands the tail of the buffer, after data has been written to
|
||||||
* the buffer returned by write().
|
* the buffer returned by Write().
|
||||||
*/
|
*/
|
||||||
void Append(size_type n) {
|
void Append(size_type n) {
|
||||||
assert(tail <= size);
|
assert(tail <= size);
|
||||||
|
Loading…
Reference in New Issue
Block a user