Mercurial > archived > louis > epitech > zia-api
changeset 20:0a0275d9c731
added comments on the streambuf pointers
author | Zoltan K |
---|---|
date | Sun, 21 Mar 2010 09:59:09 +0100 |
parents | 2035bdfd2ca8 |
children | e2c0396cfb29 |
files | src/examples/Buffer/Buffer.hpp |
diffstat | 1 files changed, 13 insertions(+), 5 deletions(-) [+] |
line wrap: on
line diff
--- a/src/examples/Buffer/Buffer.hpp Sun Mar 21 00:06:12 2010 +0100 +++ b/src/examples/Buffer/Buffer.hpp Sun Mar 21 09:59:09 2010 +0100 @@ -16,11 +16,19 @@ ** and we will call @b get, all operations that consume the buffer's content ** (operations performed by std::istream) ** - ** The std::streambuf abstract class works with two pointers. One @b get pointer - ** and one @b put pointer. These pointers are sets by two methods: - ** setp (set the put pointer) - ** setg (set the get pointer). - ** Anyway, these pointers can be moved using seekoff and seekpos. + ** The std::streambuf abstract class works with two kind of pointers. @b get pointers + ** and @b put pointers. + ** @n + ** For each kind of pointer, there are three different pointers: + ** @li A pointer to the beginning of the sequence + ** @li A pointer to the current position + ** @li A pointer to the end of the sequence + ** + ** These pointers are sets by two methods: + ** @li setp (set @b put pointers) + ** @li setg (set @b get pointers). + ** + ** Anyway, these pointers can be moved using @ref seekoff and @ref seekpos. ** Any operation that add or remove content from the buffer should move the ** appropriate pointer. **