changeset 14:eb31288ea1ae

merge
author Zoltan K
date Sat, 20 Mar 2010 22:10:49 +0100
parents 094f9bdd7d3a
children ceb2499994ce
files src/examples/Buffer/Buffer.hpp
diffstat 1 files changed, 13 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/src/examples/Buffer/Buffer.hpp	Sat Mar 20 22:03:18 2010 +0100
+++ b/src/examples/Buffer/Buffer.hpp	Sat Mar 20 22:10:49 2010 +0100
@@ -80,7 +80,20 @@
      */
     virtual int                 sync(void);
 
+
+    /**
+     ** @brief This method get the number of characters available once the buffer is empty.
+     ** @return An estimation on the number of characters that could be
+     ** added to the buffer if an underflow is made.
+     */
     virtual std::streamsize     showmanyc(void);
+
+    /**
+     ** @brief This method gets characters from the buffer.
+     ** @param [in] s Array where the gotten characters must be stored.
+     ** @param [in] n Number of characters to store.
+     ** @return The number of characters stored.
+     */
     virtual std::streamsize     xsgetn(char * s, streamsize n);
     virtual int                 underflow(void);
     virtual int                 uflow(void);